Geospatial Messenger provides a RESTful API for users and messages.
Person-service tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
| Verb | Usage |
|---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to delete an existing resource |
Person-service tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
| Status code | Usage |
|---|---|
|
Standard response for successful HTTP requests. |
The actual response will depend on the request method used. |
In a GET request, the response will contain an entity corresponding to the requested resource. |
In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The User resource is used to create, modify and list users.
A POST request creates a new user.
This PUT request updates the user’s location.
A GET request lists all of the users.
This GET request lists all the users within the provided bounding box.
The Message resource is used to create, modify and list messages.
A POST request creates a new message.
A GET request lists all of the messages.
This GET request lists all the messages within the provided bounding box.
A SSE endpoint that received all the new messages.