Info

Created 28-07-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /filters

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
 sPageName
 Page Name
 String
 nRefID
 Ref ID
 Integer
 sAction
 Action
 String
 sFilterType
 Filter Type
 String
Curl example

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

Response

200 (OK) :  array of filters
Response body
[
{
    "ID": 1,
    "FilterCode": "CHEF",
    "Description": "Chef",
    "ColorCode": "SMARTTID",
    "Color": "#228fce",
    "AvailableEmployee": true,
    "AvailableJournal": true,
    "AvailableShiftPlanning": true,
    "AvailableSmartPoint": true,
    "AvailableTeamPlanning": true
  },
  {
    "ID": 5,
    "FilterCode": "CLEANASSIST",
    "Description": "Cleaning assistent",
    "ColorCode": "GUL",
    "Color": "#a09030",
    "AvailableEmployee": true,
    "AvailableJournal": true,
    "AvailableShiftPlanning": true,
    "AvailableSmartPoint": true,
    "AvailableTeamPlanning": true
  },
  {
    "ID": 2,
    "FilterCode": "DISHWASHER",
    "Description": "Dish washers",
    "ColorCode": "GRØN",
    "Color": "#1b893d",
    "AvailableEmployee": true,
    "AvailableJournal": true,
    "AvailableShiftPlanning": true,
    "AvailableSmartPoint": true,
    "AvailableTeamPlanning": true
  },
]


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} : /filters/{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 filter
 Integer
Curl example

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

Response

200 (OK) : the filter

Response Body
[ 
{ 
"ID": 2, 
"FilterCode": "DISHWASHER", 
"Description": "Dish washers", 
"ColorCode": "GRØN", 
"Color": "#1b893d", 
"AvailableEmployee": true, 
"AvailableJournal": true, 
"AvailableShiftPlanning": true, 
"AvailableSmartPoint": true, 
"AvailableTeamPlanning": true 
},
]


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: /filters


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

Request body
{
"sFilterCode": "string",
  "sDescription": "string",
  "sFilterType": "string",
  "sFilterMatch": "string",
  "sColorCode": "string",
  "bAvailableEmployee": true,
  "bAvailableJournal": true,
  "bAvailableShiftPlanning": true,
  "bAvailableSmartPoint": true,
  "bAvailableTeamPlanning": true
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/filters" -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 { \"sFilterCode\": \"string\", \"sDescription\": \"string\", \"sFilterType\": \"string\", \"sFilterMatch\": \"string\", \"sColorCode\": \"string\", \"bAvailableEmployee\": true, \"bAvailableJournal\": true, \"bAvailableShiftPlanning\": true, \"bAvailableSmartPoint\": true, \"bAvailableTeamPlanning\": true }"

Response

200 (OK) : The ID of the new 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}: /filters/{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 filter
 Integer

Request body

{
"sFilterCode": "string", 
"sDescription": "string", 
"sFilterType": "string", 
"sFilterMatch": "string", 
"sColorCode": "string", 
"bAvailableEmployee": true, 
"bAvailableJournal": true, 
"bAvailableShiftPlanning": true, 
"bAvailableSmartPoint": true, 
"bAvailableTeamPlanning": true 
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/filters/id" -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 { \"sFilterCode\": \"string\", \"sDescription\": \"string\", \"sFilterType\": \"string\", \"sFilterMatch\": \"string\", \"sColorCode\": \"string\", \"bAvailableEmployee\": true, \"bAvailableJournal\": true, \"bAvailableShiftPlanning\": true, \"bAvailableSmartPoint\": true, \"bAvailableTeamPlanning\": true }"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /filters/{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 filter
 Integer

Curl example

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



Object

Filter
 Name
 Description
 Type
sFilterCode
 Code of filter
 String
sDescription
 Description
 String
 sFilterType
 Filter Type
String
 sFilterMatch
 Filter Match
 String
 sColorCode
 Color Code
String
 bAvailableEmployee
 Available Employee
bool 
 bAvailableJournal
 Available Journal
 bool
 bAvailableShiftPlanning
 Available Shift Planning
 bool
 bAvailableSmartPoint
 Available SmartPoint
 bool
 bAvailableTeamPlanning
 Available Team Planning
 bool