Info

Created 09-02-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /salaryenclosuresetups

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
 sSalaryEnclosureCode - required
 Salary Enclosure Code
 String

Curl example

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

Response

200 (OK) :  array of salary enclosure setups

Response body
[
{
    "ID": 238,
    "ColumnNumber": 1,
    "LanguageCode": "DK",
    "Header": "Normaltid"
  },
  {
    "ID": 241,
    "ColumnNumber": 1,
    "LanguageCode": "EN",
    "Header": "Normaltid"
  }
]

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} : /salaryenclosuresetups/{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 salary enclosure setup
 Integer
Curl example

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

Response

200 (OK) : the salary enclosure setup

Response Body
[
    { 
"ID": 238, 
"ColumnNumber": 1, 
"LanguageCode": "DK", 
"Header": "Normaltid" 
},
]


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: /salaryenclosuresetups?sSalaryEnclosureCode=XXXX


Parameters
 Name
 Description
 Type
 API-key - required
  Authorization Token  
 String(64)
 UID - required
 UID -how can be obtained
 String
 DEVICEID - required
  DEVICEID
 String
 sSalaryEnclosureCode -required
 Salary Enclosure Code
 String

Request body
{
 "nColumnNumber": 0,
  "sLanguageCode": "string",
  "sHeader": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/salaryenclosuresetups?sSalaryEnclosureCode=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 { \"nColumnNumber\": 0,  \"sLanguageCode\": \"string\",  \"sHeader\": \"string\"}"

Response

200 (OK) : The ID of the new salary enclosure setup

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}: /salaryenclosuresetups/{id}?sSalaryEnclosureCode=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 salary enclosure setup
 Integer
 sSalaryEnclosureCode - required
 Salary Enclosure Code
 String

Request body

{
 "nColumnNumber": 0,
  "sLanguageCode": "string",
  "sHeader": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/salaryenclosuresetups/id?sSalaryEnclosureCode=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 {\"nColumnNumber\": 0,  \"sLanguageCode\": \"string\",  \"sHeader\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /salaryenclosuresetups/{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 salary enclosure setup
 Integer

Curl example

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

Salary Enclosure Setup
 Name
 Description
 Type
nColumnNumber
Column Number
Integer
 sLanguageCode
Language Code
 String
sHeader
Header
String