API Requests

WhosOnLocation provides a RESTful API for managing data. The API currently supports JSON or XML data and is chosen via the Accept and Content-Type headers

GET

Retrieve information. GET requests must be safe and idempotent, meaning regardless of how many times it repeats with the same parameters, the results are the same. They can have side effects, but the user doesn't expect them, so they cannot be critical to the operation of the system. Requests can also be partial or conditional.

Retrieve a Staff with an ID of 1:

GET /staff/1

POST

Request that the resource at the URI do something with the provided entity. Often POST is used to create a new entity, but it can also be used to update an entity. See our API specification for the required data to create the resource.

Create a new staff member:

POST /staff

PUT

Update an entity at a URI. PUT can update an existing one. A PUT request is idempotent.

Modify the staff profile with an ID of 1:

PUT /staff/1

Note: PUT replaces an existing entity. If only a subset of data elements are provided, the rest will be replaced with empty or null.

DELETE

Request that a resource be removed; however, the resource does not have to be removed immediately. It could be an asynchronous or long-running request.