Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

It describes the URLs/resources published by the REST Module.

For more information on conventions, authentication, and setup, see the main Rest Web Service page.

Person

URLs

url

description

GET /ws/rest/v1/person

Fetch all non-retired that match any specified parameters otherwise fetch all non-retired

GET /ws/rest/v1/person/{uuid}

Fetch by unique uuid

POST /ws/rest/v1/person

Create with properties in request

POST /ws/rest/v1/person/{uuid}

Edit with given uuid, only modifying properties in request

DELETE /ws/rest/v1/person/{uuid}?!purge

Retire/Void this object

DELETE /ws/rest/v1/person/{uuid}?purge

Delete this object from the database

...