Info

Created 31-08-2020 by Lavinia Gheghea

Revision

--

Description

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

Endpoints


GET:  /counters


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/counters" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :  array of counters

Response body
[ 
{
    "ID": 13,
    "CounterCode": "FERIE",
    "Description": "Feriedage",
    "ShowOnLogin": true,
    "ShowAsDays": false,
    "CounterMin": 0,
    "CounterMax": 0,
    "CounterMinMaxActive": false,
    "IncludeFlex": false,
    "ShowPlannedToDate": null
  },
  {
    "ID": 14,
    "CounterCode": "FERIEFRI",
    "Description": "Feriefri timer",
    "ShowOnLogin": true,
    "ShowAsDays": false,
    "CounterMin": 0,
    "CounterMax": 0,
    "CounterMinMaxActive": false,
    "IncludeFlex": false,
    "ShowPlannedToDate": null
  },
]



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} : /counters/{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 counter
 Integer
Curl example

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

Response

200 (OK) : the counter

Response Body
[ 
 { 
"ID": 14, 
"CounterCode": "TEST", 
"Description": "Test", 
"ShowOnLogin": true, 
"ShowAsDays": false, 
"CounterMin": 0, 
"CounterMax": 0, 
"CounterMinMaxActive": false, 
"IncludeFlex": false, 
"ShowPlannedToDate": null }
]

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: /counters


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
{
"sCounterCode": "string",
  "sDescription": "string",
  "bShowOnLogin": true,
  "bShowAsDays": true,
  "nCounterMin": 0,
  "nCounterMax": 0,
  "bCounterMinMaxActive": true,
  "bIncludeFlex": true,
  "dtShowPlannedToDate": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/counters" -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 "{\"sCounterCode\": \"string\", \"sDescription\": \"string\", \"bShowOnLogin\": true, \"bShowAsDays\": true, \"nCounterMin\": 0, \"nCounterMax\": 0, \"bCounterMinMaxActive\": true, \"bIncludeFlex\": true, \"dtShowPlannedToDate\": \"string\"}"

Response

200 (OK) : The ID of the new counter

Response Body
[
 {
  "ID": 3
 }
]
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}: /counters/{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 counter
 Integer

Request body
{
"sCounterCode": "string",
 "sDescription": "string",
"bShowOnLogin": true, 
"bShowAsDays": true, 
"nCounterMin": 0, 
"nCounterMax": 0, 
"bCounterMinMaxActive": true, 
"bIncludeFlex": true, 
"dtShowPlannedToDate": "string" 
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/counters/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 "{\"sCounterCode\": \"string\", \"sDescription\": \"string\", \"bShowOnLogin\": true, \"bShowAsDays\": true, \"nCounterMin\": 0, \"nCounterMax\": 0, \"bCounterMinMaxActive\": true, \"bIncludeFlex\": true, \"dtShowPlannedToDate\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /counters/{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 counter
 Integer

Curl example

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


Counter
 Name
 Description
 Type
sCounterCode
 Code of counter
 String
sDescription
 Description
 String
 bShowOnLogin
 Show on Login
 bool
 bShowAsDays
 Show as Days
 bool
 nCounterMin
 Counter Min Value
 double
 nCounteMax
 Counter Max Value
 double
 bCounterMinMaxActive
 Counter Min Max Active
 bool
 bIncludeFlex
 Include Flex
 bool
 dtShowPlannedToDate
 Show Planned to Date
 string  format as dd-mm-yyyy