Info

Created 02-06-2022 by Lavinia Gheghea

Revision



Description

The API allows you to create, delete, and update user employee employee group filters. You can retrieve individual user employee employeegroup filter as well as a list of all user employee employee group filters.

Endpoints


GET:  /useremployeeemployeegroupfilters

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
 sSystemID - required
 SystemID of the user
 String
 sAction
 Action 
 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/useremployeeemployeegroupfilters?sSystemID=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 useremployeeemployeegroupfilters
Response body
[
  {
    "ID": 40,
    "SystemID": "1009",
    "EmployeeGroupCode": "1",
    "EmployeeGroupName": "Employee Group 1"
  },
  {
    "ID": 37,
    "SystemID": "1009",
    "EmployeeGroupCode": "2",
    "EmployeeGroupName": "employee group 2"
  }
]


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} : /useremployeeemployeegroupfilters/{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 useremployeeemployeegroupfilter
 Integer
Curl example

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

Response

200 (OK) : the user employee employee group filter

Response Body
[
  {
    "ID": 40,
    "SystemID": "1009",
    "EmployeeGroupCode": "1",
    "EmployeeGroupName": "Employee Group 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: /useremployeeemployeegroupfilters


Parameters
 Name
 Description
 Type
 API-key - required
  Authorization Token  
 String(64)
 UID - required
 UID -how can be obtained
 String
 DEVICEID - required
  DEVICEID
 String
 sSystemID
 System ID of the user
 String
 sEmployeeGroupCode
 Employee Group Code
 String


Curl example
curl -X POST "https://smartapi.smarttid.dk/useremployeeemployeegroupfilters?sSystemID=XXXX&sEmployeeGroupCode=YYYY" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" 

Response

200 (OK) : The ID of the new user employee employee group filter

Response Body
[
 {
  "ID": 30
 }
]
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}: /useremployeeemployeegroupfilters/{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 user employee employee group filter
 Integer
 sSystemID
 SystemID
 string
 sEmployeeGroupCode
 Employee Group Code
 string 



Curl example

curl -X PUT "https://smartapi.smarttid.dk/useremployeeemployeegroupfilters/id?sSystemID=XXXX&sEmployeeGroupCode=YYYY" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" 

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /useremployeeemployeegroupfilters/{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 user employee employee group filter
 Integer

Curl example

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


SQL Procedure 



sp_UserEmployeeEmployeeGroupFilter



Object

UserEmployeeEmployeeGroup
 Name
 Description
 Type
sSystemID
 SystemID
 String
sEmployeeGroupCode
 Employee Group Code
 String