Info

Created 09-02-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /salaryenclosures


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

Response

200 (OK) :  array of salary enclosures

Response body
[ 
{
    "ID": 14,
    "SalaryEnclosureCode": "PCV",
    "Description": "Test PCV",
    "ShowLogTime": true,
    "ShowTime": true,
    "ShowNormTime": true,
    "ShowBreakTime": true,
    "ShowPaidBreakTime": true,
    "ShowColumnsAsTime": false,
    "ShowRemarks": false,
    "IncludeNonPosted": false,
    "CompressColumns": false
  },
  {
    "ID": 1,
    "SalaryEnclosureCode": "STANDARD",
    "Description": "Standard lønbilag",
    "ShowLogTime": true,
    "ShowTime": true,
    "ShowNormTime": true,
    "ShowBreakTime": true,
    "ShowPaidBreakTime": false,
    "ShowColumnsAsTime": false,
    "ShowRemarks": true,
    "IncludeNonPosted": false,
    "CompressColumns": false
  },
  {
    "ID": 26,
    "SalaryEnclosureCode": "TEST",
    "Description": "test",
    "ShowLogTime": false,
    "ShowTime": false,
    "ShowNormTime": false,
    "ShowBreakTime": false,
    "ShowPaidBreakTime": false,
    "ShowColumnsAsTime": false,
    "ShowRemarks": false,
    "IncludeNonPosted": false,
    "CompressColumns": 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} : /salaryenclosures/{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
 Integer
Curl example

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

Response Body
[ 
 { 
"ID": 26, 
"SalaryEnclosureCode": "TEST", 
"Description": "test", 
"ShowLogTime": false, 
"ShowTime": false, 
"ShowNormTime": false, 
"ShowBreakTime": false, 
"ShowPaidBreakTime": false, 
"ShowColumnsAsTime": false, 
"ShowRemarks": false, 
"IncludeNonPosted": false, 
"CompressColumns": 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: /salaryenclosures


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
{
"sSalaryEnclosureCode": "string",
  "sDescription": "string",
  "bShowLogTime": true,
  "bShowTime": true,
  "bShowNormTime": true,
  "bShowBreakTime": true,
  "bShowPaidBreakTime": true,
  "bShowColumnsAsTime": true,
  "bShowRemarks": true,
  "bIncludeNonPosted": true,
  "bCompressColumns": true,
  "sCopyFromSalaryEnclosureCode": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/salaryenclosures" -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 "{\"sSalaryEnclosureCode\": \"string\",  \"sDescription\": \"string\",  \"bShowLogTime\": true,  \"bShowTime\": true,  \"bShowNormTime\": true,  \"bShowBreakTime\": true,  \"bShowPaidBreakTime\": true,  \"bShowColumnsAsTime\": true,  \"bShowRemarks\": true,  \"bIncludeNonPosted\": true,  \"bCompressColumns\": true,  \"sCopyFromSalaryEnclosureCode\": \"string\"}"

Response

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

Response Body
[
 {
  "ID": 14
  }
]
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}: /salaryenclosures/{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
 Integer

Request body
{
"sSalaryEnclosureCode": "string",
  "sDescription": "string",
  "bShowLogTime": true,
  "bShowTime": true,
  "bShowNormTime": true,
  "bShowBreakTime": true,
  "bShowPaidBreakTime": true,
  "bShowColumnsAsTime": true,
  "bShowRemarks": true,
  "bIncludeNonPosted": true,
  "bCompressColumns": true,
  "sCopyFromSalaryEnclosureCode": "string"
}
Curl example

curl -X PUT "https://smartapi.smarttid.dk/salaryenclosures/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 "{\"sSalaryEnclosureCode\": \"string\",  \"sDescription\": \"string\",  \"bShowLogTime\": true,  \"bShowTime\": true,  \"bShowNormTime\": true,  \"bShowBreakTime\": true,  \"bShowPaidBreakTime\": true,  \"bShowColumnsAsTime\": true,  \"bShowRemarks\": true,  \"bIncludeNonPosted\": true,  \"bCompressColumns\": true,  \"sCopyFromSalaryEnclosureCode\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


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

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/salaryenclosures/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
 Name
 Description
 Type
sSalaryEnclosureCode
 Code of salary enclosure
 String
sDescription
 Description
 String
 bShowLogTime
 Show Log Time
 bool
 bShowTime
 Show Time
 bool
 bShowNormTime
 Show Norm Time
 bool
 bShowBreakTime
 Show Break Time
 bool
 bShowPaidBreakTime
 Show Paid Break Time
 bool
 bShowColumnAsTime
 Show Column As Time
 bool
 bShowRemarks
 Show Remarks
 bool
 bIncludeNonPosted
 Include Non Posted
 bool
 bCompressColumns
 Compress Columns
 bool
 sCopyFromSalaryEnclosureCode
 Copy From SalaryEnclosure Code
 string