Info

Created 05-10-2020 by Lavinia Gheghea

Revision



Description

The API allows you to create, delete, and update  counterline. You can retrieve individual counterline as well as a list of all counterlines.

Endpoints


GET:  /counterlines


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
 sCounterCode -required
 Code of counter
 String

Curl example

curl -X GET "https://smartapi.smarttid.dk/counterlines?sCounterCode=xxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :  array of counterlines from the counter

Response body
[ 
{
    "ID": 25,
    "CounterCode": "FERIE",
    "WorkTypeCode": "FERIEOP",
    "Factor": 1,
    "CountRegistrations": false,
    "IncludePlannedAbsence": false,
    "OnlyToCurrentDate": false
  },
  {
    "ID": 26,
    "CounterCode": "FERIE",
    "WorkTypeCode": "FERIE",
    "Factor": -1,
    "CountRegistrations": false,
    "IncludePlannedAbsence": false,
    "OnlyToCurrentDate": false
  }
]


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} : /counterlines/{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 counterline
 Integer
Curl example

curl -X GET "https://smartapi.smarttid.dk/counterlines/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) : the counterline

Response Body
[ 
{ 
"ID": 25, 
"CounterCode": "FERIE", 
"WorkTypeCode": "FERIEOP", 
"Factor": 1, 
"CountRegistrations": false, 
"IncludePlannedAbsence": false, 
"OnlyToCurrentDate": false 
}
]

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: /counterlines?sCounterCode=XXXX


Parameters
 Name
 Description
 Type
 API-key - required
 Authorization Token 
 String(64)
 UID - required
 UID -how can be obtained
 String
 DEVICEID - required
  DEVICEID
 String
 sCounterCode - required
 Code of the counter
 String

Request body
{
  "sWorkTypeCode": "string",
  "nFactor": 0,
  "bCountRegistrations": true,
  "bIncludePlannedAbsence": true,
  "bOnlyToCurrentDate": true
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/counterlines?sCounterCode=XXXX" -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 "{ \"sWorkTypeCode\": \"string\", \"nFactor\": 0, \"bCountRegistrations\": true, \"bIncludePlannedAbsence\": true, \"bOnlyToCurrentDate\": true }"

Response

200 (OK) : The ID of the new counterline

Response Body
[
 {
  "ID": 45
  }
]
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}: /counterlines/{id}?sCounterCode=XXXX


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 counterline
 Integer
 sCounterCode - required
 Code of the counter
 String

Request body

{ 
"sWorkTypeCode": "string", 
"nFactor": 0, 
"bCountRegistrations": true, 
"bIncludePlannedAbsence": true, 
"bOnlyToCurrentDate": true 
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/counterlines/id>sCounterCode=XXXX" -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 "{ \"sWorkTypeCode\": \"string\", \"nFactor\": 0, \"bCountRegistrations\": true, \"bIncludePlannedAbsence\": true, \"bOnlyToCurrentDate\": true }"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /counterlines/{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 counterline
 Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/counterlines/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

CounterLine
 Name
 Description
 Type
sWorkTypeCode
 Code of worktype
 String
nFactor
Factor
 Double(number)
 bCountRegistrations
 Count registrations
 boolean
 bIncludePlannedAbsence
 Include Plannned Absence
 boolean
 bOnlyToCurrentDate
 Only to Current Date
 boolean