Info

Created 08-02-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /employeequalifications?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/employeequalifications?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 qualifications

Response body
[ 
{
    "ID": 2,
    "EmployeeCode": "9999",
    "QualificationCode": "DRIVERL_C1",
    "QualificationLevelCode": "NOVICE",
    "QualificationDate": "2018-11-24T00:00:00",
    "RenewQualificationDate": "2063-09-30T00:00:00",
    "StartDate": "2018-11-01T00:00:00",
    "EndDate": "2063-10-01T00:00:00"
  },
  {
    "ID": 5,
    "EmployeeCode": "9999",
    "QualificationCode": "TRUCKCERT",
    "QualificationLevelCode": "EXPERT",
    "QualificationDate": "2021-01-01T00:00:00",
    "RenewQualificationDate": "2029-01-01T00:00:00",
    "StartDate": "2021-01-01T00:00:00",
    "EndDate": "2028-12-31T00:00:00"
  }
]


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} : /employeequalifications/{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 qualification
 Integer
Curl example

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

Response

200 (OK) : the employee qualification

Response Body
[ 
{
    "ID": 2,
    "EmployeeCode": "9999",
    "QualificationCode": "DRIVERL_C1",
    "QualificationLevelCode": "NOVICE",
    "QualificationDate": "2018-11-24T00:00:00",
    "RenewQualificationDate": "2063-09-30T00:00:00",
    "StartDate": "2018-11-01T00:00:00",
    "EndDate": "2063-10-01T00:00:00"
  },
]

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: /employeequalifications?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
{
"sQualificationCode": "string",
  "sQualificationLevelCode": "string",
  "dtQualificationDate": "string",
  "dtRenewQualificationDate": "string",
  "dtStartDate": "string",
  "dtEndDate": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/employeequalifications?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 "{\"sQualificationCode\": \"string\",  \"sQualificationLevelCode\": \"string\",  \"dtQualificationDate\": \"string\",  \"dtRenewQualificationDate\": \"string\",  \"dtStartDate\": \"string\",  \"dtEndDate\": \"string\"}"

Response

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

Response Body
[
 {
  "ID": 25
 }
]
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}: /employeequalifications/{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 qualification
 Integer

Request body
{
"sQualificationCode": "string",
  "sQualificationLevelCode": "string",
  "dtQualificationDate": "string",
  "dtRenewQualificationDate": "string",
  "dtStartDate": "string",
  "dtEndDate": "string" 
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/employeequalifications/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 "{\"sQualificationCode\": \"string\",  \"sQualificationLevelCode\": \"string\",  \"dtQualificationDate\": \"string\",  \"dtRenewQualificationDate\": \"string\",  \"dtStartDate\": \"string\",  \"dtEndDate\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


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

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/employeequalifications/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 Qualification
 Name
 Description
 Type
sQualificationCode
 Qualification Code
 String
sQualificationLevelCode
Qualification Level Code
 String
dtQualificationDate
Qualification Date
 String
 dtRenewQualificationDate
Renew Qualification Date
 String
 dtStartDate
 Start Date
 String
dtEndDate
End Date
 String