The Basics

REST

The API is RESTful and follows REST conventions.

You typically create data using a POST request, read data using a GET, update it with a PUT and delete it with a DELETE

We don't yet support PATCH, so when updating an entity be sure to include all JSON for write-able properties.


IDs

Most resources are identified by an ID string, which is in the format of a GUID, i.e. 7307a0da-1475-4fa3-b39f-a6b0583ef7d4.

These IDs most typically appear in URLs.

Example

The URL to get an employee is stated as /employers/{employerId}/employee/{id}.

The actual URL you would request would be similar to
/employers/7307a0da-1475-4fa3-b39f-a6b0583ef7d4/employee/b6d669c3-c7ed-47c0-ab5c-0fafe37e00eb.
where the first ID is that of the Employer and the second ID is for the Employee you wish to get.