Info

Created 09-02-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /salaryenclosuresetupworktypes

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
 sAction - required Action String

Curl example

curl -X GET "https://smartapi.smarttid.dk/salaryenclosuresetupworktypes?sSalaryEnclosureCode=XXXX&sAction=SELECT" -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 setup work types

Response body
[
{
    "ID": 137,
    "SalaryEnclosureCode": "STANDARD",
    "ColumnNumber": 1,
    "WorkTypeCode": "AFSPADSERINGOP",
    "Factor": 1
  },
  {
    "ID": 8,
    "SalaryEnclosureCode": "STANDARD",
    "ColumnNumber": 8,
    "WorkTypeCode": "AFSPADSERING",
    "Factor": -1
  },
  {
    "ID": 73,
    "SalaryEnclosureCode": "STANDARD",
    "ColumnNumber": 8,
    "WorkTypeCode": "FERIE",
    "Factor": 1
  },
]

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} : /salaryenclosuresetupworktypes/{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 work type
 Integer
Curl example

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

Response Body
[
    { 
"ID": 73, 
"SalaryEnclosureCode": "STANDARD", 
"ColumnNumber": 8, 
"WorkTypeCode": "FERIE", 
"Factor": 1 
},
]


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: /salaryenclosuresetupworktypes?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,
  "sWorkTypeCode": "string",
  "nFactor": 0
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/salaryenclosuresetupworktypes?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,  \"sWorkTypeCode\": \"string\",  \"nFactor\": 0}"

Response

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

Response Body
[
 {
  "ID": 83
 }
]
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}: /salaryenclosuresetupworktypes/{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 work type
 Integer
 sSalaryEnclosureCode - required
 Salary Enclosure Code
 String

Request body

{
  "nColumnNumber": 0,
  "sWorkTypeCode": "string",
  "nFactor": 0
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/salaryenclosuresetupworktypes/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,  \"sWorkTypeCode\": \"string\",  \"nFactor\": 0}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /salaryenclosuresetupworktypes/{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 work type
 Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/salaryenclosuresetupworktypes/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 Work Type
 Name
 Description
 Type
nColumnNumber
Column Number
Integer
 sWorkTypeCode
Work Type Code
 String
nFactorFactorNumber(double)