PlaceApi
| HTTP request | Description |
|---|---|
| POST /place | Creates a new place for an organization. |
| DELETE /place/{placeId} | Deletes a place of an organization. |
| GET /place/organization/{organizationId} | Returns the list of places of the organization. |
| PUT /place | Updates one or more properties of a place of an organization. |
POST /place
Creates a new place for an organization. Only web-app administrators can access this end-point.
Parameters
| Name | Type | Description |
|---|---|---|
| place | Place |
Responses
201
The new place of the organization was created. The place gets returned. Place
400
The new tracking area does not respect the area constraints for the organization. Nothing gets returned.
401
The administrator is not authenticated. Nothing gets returned.
403
Users or administrator with viewer permission cannot have access. Nothing gets returned.
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
DELETE /place/{placeId}
Deletes a place of an organization. Only web-app administrators can access this end-point.
Parameters
| Name | Type | Description |
|---|---|---|
| placeId | Long | ID of a place. |
Responses
205
Place successfully removed from the list of places of the organization. Nothing gets returned.
401
The administrator is not authenticated. Nothing gets returned.
403
Users and administrators with viewer permissions cannot have access. Nothing gets returned.
404
The place could not be found. Nothing gets returned.
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
GET /place/organization/{organizationId}
Returns the list of places of the organization. Both app users and web-app administrators can access this end-point.
Parameters
| Name | Type | Description |
|---|---|---|
| organizationId | Long | ID of an organization. |
Responses
200
Place list of organization returned successfully. List
204
Place list of organization is empty. Nothing gets returned.
401
The administrator or the user is not authenticated. Nothing gets returned.
403
Administrators who are not bound to the organization cannot access this end-point. Nothing gets returned.
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
PUT /place
Updates one or more properties of a place of an organization. Only web-app administrators can access this end-point.
Parameters
| Name | Type | Description |
|---|---|---|
| place | Place |
Responses
200
Place updated successfully. The updated place gets returned. Place
400
The inserted data has some issues. Nothing gets returned.
401
The administrator is not authenticated. Nothing gets returned.
403
Users or administrator with viewer permission cannot have access. Nothing gets returned.
404
Invalid place ID supplied. Nothing gets returned.
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json