Info

Created 07-10-2020 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /employeeoperations?sEmployeeCode=xxxx


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
 sEmployeeCode- required
 Employee Code
 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/employeeoperations?sEmployeeCode=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :  array of employee operations

Response body
[ 
{
    "ID": 2,
    "OperationCode": null,
    "OperationGroupCode": "ATEST",
    "Description": "Test operation group",
    "OperationDescription": null,
    "OperationGroupDescription": "Test operation group"
  },
  {
    "ID": 5,
    "OperationCode": "ARBEJDE",
    "OperationGroupCode": null,
    "Description": "Arbejde",
    "OperationDescription": "Arbejde",
    "OperationGroupDescription": null
  },
  {
    "ID": 6,
    "OperationCode": "TEST",
    "OperationGroupCode": null,
    "Description": "test",
    "OperationDescription": "test111",
    "OperationGroupDescription": 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} : /employeeoperations/{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 employee operation
 Integer
Curl example

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

Response

200 (OK) : the employee absence

Response Body
[ 
 { 
"ID": 2, 
"OperationCode": null, 
"OperationGroupCode": "ATEST", 
"Description": "Test operation group", 
"OperationDescription": null, 
"OperationGroupDescription": "Test operation group" 
}
]

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: /employeeoperations?sEmployeeCode=xxxx


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

Request body
{
"sOperationCode": "string",
  "sOperationGroupCode": "string",
  "sDescription": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/employeeoperations?sEmployeeCode=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 "{/"sOperationCode/": /"string/",/"sOperationGroupCode/": /"string/",/"sDescription/": /"string/"}"

Response

200 (OK) : The ID of the new employee operation

Response Body
[
 {
  "ID": 25033
 }
]
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}: /employeeoperations/{id}?sEmployeeCode=xxxx


Parameters
 Name
 Description
 Type
 API-key - required
 Authorization Token
 String(64)
 UID - required
UID -how can be obtained
 String
 DEVICEID - required
 DEVICEID
 String
 sEmployeeCode - required
 Employee Code
 String
 id- required
 ID of employee operation
 Integer

Request body
{
"sOperationCode": "string",
  "sOperationGroupCode": "string",
  "sDescription": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/employeeoperations/id?sEmployeeCode=xxx" -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 "{/"sOperationCode/": /"string/",/"sOperationGroupCode/": /"string/",/"sDescription/": /"string/"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /employeeoperations/{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 employee operation
 Integer

Curl example

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

Employee Operation
 Name
 Description
 Type
sOperationCode
 Operation Code
 String
sOperationGroupCode
 Operation Group Code
 String
 sDescription
 Description
 String