Info
Created 27-08-2020 by Lavinia
Gheghea
Revision
--
Description
The API
allows you to create, delete,
and update grounds for termination.
You can retrieve individual grounds for termination as well as a list
of all grounds for termination.
Endpoints
GET: /groundsforterminations
Parameters
Headers and Query
| Name | Description | Type |
| API-key - required | Authorization Token | String(64) |
| UID - required | UID -how can be obtained | String |
| DEVICEID - required | DEVICEID | String |
| offset | starting record | Integer |
| limit | how many records displayed
on a page | Integer |
| OrderFieldName | field name to order the
recordset | String |
| OrderDirection | ASC or DESC | String |
| Filter | filter the recordset | String |
Curl example
curl -X GET "https://smartapi.smarttid.dk/groundsforterminations" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) : array of grounds for terminations
Response body
[{ "ID": 7, "GroundsForTerminationCode": "OPSAGT", "Description": "Opsagt" }, { "ID": 8, "GroundsForTerminationCode": "SELVSAGTOP", "Description": "Quit on own accord" }]
Response headers:
content-encoding: gzip content-length: 238 content-type: application/json; charset=utf-8 date: Mon, 24 Aug 2020 08:01:23 GMT server: Microsoft-IIS/10.0 vary: Accept-Encoding x-pagination: {"totalCount":4,"totalFiltered":4,"Offset":0,"Limit":4,"Returned":4} x-powered-by: ASP.NET
400 (ERROR) : Error
message
Response Body
Error message
GET{id} : /groundsforterminations/{id}
Parameters
| Name | Description | Type |
| API-key - required | Authorization Token | String(64) |
| UID - required | UID -how can be obtained | String |
| DEVICEID - required | DEVICEID | String |
| id- required | ID of groundsfortermination | Integer |
Curl example
curl -X GET "https://smartapi.smarttid.dk/groundsforterminations/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) : the grounds for termination
Response Body
[ { "ID": 7, "GroundsForTerminationCode": "OPSAGT", "Description": "Opsagt" },]
Response Headers
content-encoding: gzip content-length: 175 content-type: application/json; charset=utf-8 date: Mon, 24 Aug 2020 08:39:57 GMT server: Microsoft-IIS/10.0 vary: Accept-Encoding x-powered-by: ASP.NET
400 (ERROR) : Error message
Response Body
Error message
POST: /groundsforterminations
Parameters
| Name | Description | Type |
| API-key - required | Authorization Token | String(64) |
| UID - required | UID -how can be obtained | String |
| DEVICEID - required | DEVICEID | String |
Request body
{ "sGroundsForTerminationCode": "string", "sDescription": "string" }
Curl example
curl -X POST "https://smartapi.smarttid.dk/groundforterminations" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json-patch+json" -d "{\"sGroundsForTerminationCode\":\"12345\",\"sDescription\":\"test\"}"
Response
200 (OK) : The ID of the new grounds for termination
Response Body
[ { "ID": 25033 } ]
Response Headers
content-encoding: gzip content-length: 138 content-type: application/json; charset=utf-8 date: Mon, 24 Aug 2020 09:24:44 GMT server: Microsoft-IIS/10.0 vary: Accept-Encoding x-powered-by: ASP.NET
400 (ERROR) : Error message
Response Body
Error message
PUT{id}: /groundsforterminations/{id}
Parameters
| Name | Description | Type |
| API-key - required | Authorization Token | String(64) |
| UID - required | UID -how can be obtained | String |
| DEVICEID - required | DEVICEID | String |
| id- required | ID of grounds for termination | Integer |
Request body
{ "sGroundsForTerminationCode": "string", "sDescription": "string" }
Curl example
curl -X PUT "https://smartapi.smarttid.dk/groundsforterminations/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json-patch+json" -d "{\"sGroundsForTerminationCode\":\"string\",\"sDescription\":\"string\"}"
Response
200 (OK) : success
400 (ERROR) : Error message
Response Body
Error message
DELETE{id}: /groundsforterminations/{id}
Parameters
| Name | Description | Type |
| API-key - required | Authorization Token | String(64) |
| UID - required | UID -how can be obtained | String |
| DEVICEID - required | DEVICEID | String |
| id- required | ID of grounds for termination | Integer |
Curl example
curl -X DELETE "https://smartapi.smarttid.dk/groundsforterminations/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) :Success
400 (ERROR) : Bad request
Response Body
Error message
Response headers
content-length: 84 content-type: text/plain; charset=utf-8 date: Tue, 25 Aug 2020 08:35:21 GMT server: Microsoft-IIS/10.0 x-powered-by: ASP.NET
Object
GroundsForTermination
| Name | Description | Type |
| sGroundsForTerminationCode | Code of grounds for termination | String |
| sDescription | Description | String |