Info

Created 07-10-2020 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /employeemessages?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/employeemessages?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 messages

Response body
[ 
{
    "ID": 1,
    "EmployeeCode": "9999",
    "ShowFromDate": "2018-12-18T00:00:00",
    "Description": "This is a new message shown on temrinal and phone which user must mark as read",
    "Read": false,
    "ReadDate": null
  },
{
    "ID": 2,
    "EmployeeCode": "9999",
    "ShowFromDate": "2019-01-12T00:00:00",
    "Description": "Test message",
    "Read": false,
    "ReadDate": 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} : /employeemessages/{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 message
 Integer
Curl example

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

Response

200 (OK) : the employee message

Response Body
[ 
{
    "ID": 1,
    "EmployeeCode": "9999",
    "ShowFromDate": "2018-12-18T00:00:00",
    "Description": "This is a new message shown on temrinal and phone which user must mark as read",
    "Read": false,
    "ReadDate": null
  }
]

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: /employeemessages?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
{
"dtShowFromDate": "string",
  "sDescription": "string",
  "bRead": true,
  "dtReadDate": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/employeemessages?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 "{/"dtShowFromDate/": /"string/",/"sDescription/": /"string/",/"bRead/": true,  /"dtReadDate/": /"string/"}"

Response

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

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}: /employeemessages/{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 message
 Integer

Request body
{
"dtShowFromDate": "string",
  "sDescription": "string",
  "bRead": true,
  "dtReadDate": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/employeemessages/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 "{/"dtShowFromDate/": /"string/",/"sDescription/": /"string/",/"bRead/": true,  /"dtReadDate/": /"string/"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


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

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/employeemessages/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 Message
 Name
 Description
 Type
dtShowFromDate
Show From Date
 String
sDescription
 Description
 String
bRead
Read
 boolean
 dtReadDate
 Read Date
 String