Workshops and Employees | Geolocation History
Service to manage entities of type 'GeolocationHistory'.
Overview
| URL | api/{tenantKey}/{orgKey}/workShopsCore/geolocationHistories |
| Methods Supported | GET, POST, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- DELETE:
All Resources
This service uses the following resources:
GET GeolocationHistories (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See GeolocationHistoryResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET GeolocationHistory by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See GeolocationHistoryResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET GeolocationHistory by key
Returns the entity record that matches the specified key.
The following elements are required:
| geolocationHistoryKey | (string) Geolocation History. |
Response:
| When successful, the response body contains the entity record. See GeolocationHistoryResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
POST GeolocationHistories
Creates a new entity record.
The following elements are required:
| geolocationHistoryResource | (ApiGeolocationHistoryResource) The request body should contain the entity record that should be created. See ApiGeolocationHistoryResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiGeolocationHistoryResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Custom Attribute GeolocationHistory
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| geolocationHistoryKey | (string) Geolocation History |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE GeolocationHistory by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE GeolocationHistory by key
Deletes the entity record that matches the specified key.
The following elements are required:
| geolocationHistoryKey | (string) Geolocation History. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiGeolocationHistoryResource
The following elements are required:
| geolocationHistoryKey | (string) Geolocation History. |
| employee | (string) Employee. |
| date | (DateTimeOffset) Date. |
| latitude | (string) Latitude. |
| longitude | (string) Longitude. |
The following elements are optional:
| map | (string) Map. |
GeolocationHistoryResource
The following elements are required:
| geolocationHistoryKey | (string) Geolocation History. |
| employee | (string) Employee.
(fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service. |
| date | (DateTimeOffset) Date. |
| latitude | (string) Latitude. |
| longitude | (string) Longitude. |
The following elements are optional:
| map | (string) Map. |