Info

Created 22-07-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /customfiltertemplates

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
 sAction
 Action
 String
Curl example

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

Response

200 (OK) :  array of custom filter templates
Response body
[
  {
    "ID": 1,
    "Description": "test",
    "Content": "{\"columns\":[\"MonthName\"],\"rows\":[\"DimensionCode1\"],\"values\":[{\"id\":\"KMTotal\",\"method\":\"sum\"},{\"id\":\"EmployeeCode\",\"method\":\"sum\"}]}"
  },
  {
    "ID": 2,
    "Description": "test 2",
    "Content": "{\"columns\":[\"MonthName\"],\"rows\":[\"DimensionCode1\"],\"values\":[{\"id\":\"KMTotal\",\"method\":\"sum\"},{\"id\":\"EmployeeCode\",\"method\":\"sum\"}]}"
  },
  {
    "ID": 3,
    "Description": "test 3",
    "Content": "{\"columns\":[\"MonthName\"],\"rows\":[\"DimensionCode1\"],\"values\":[{\"id\":\"KMTotal\",\"method\":\"sum\"},{\"id\":\"EmployeeCode\",\"method\":\"sum\"}]}"
  },
  {
    "ID": 4,
    "Description": "test 3",
    "Content": "{\"columns\":[\"MonthName\"],\"rows\":[\"DimensionCode1\"],\"values\":[{\"id\":\"KMTotal\",\"method\":\"sum\"},{\"id\":\"EmployeeCode\",\"method\":\"sum\"}]}"
  },
  {
    "ID": 5,
    "Description": "tsddfsdfsadsa",
    "Content": "{\"columns\":[\"MonthName\"],\"rows\":[\"DimensionCode1\"],\"values\":[{\"id\":\"KMTotal\",\"method\":\"sum\"},{\"id\":\"EmployeeCode\",\"method\":\"sum\"}]}"
  }
]
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} : /customfiltertemplates/{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 custom filter template
 Integer
Curl example

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

Response

200 (OK) : the custom filter template

Response Body
[ 
{ 
"ID": 5, 
"Description": "tsddfsdfsadsa", 
"Content": "{\"columns\":[\"MonthName\"],\"rows\":[\"DimensionCode1\"],\"values\":[{\"id\":\"KMTotal\",\"method\":\"sum\"},{\"id\":\"EmployeeCode\",\"method\":\"sum\"}]}" 
}
]


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


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
{
"sPageName": "string",
  "sDescription": "string",
  "bGlobal": true,
  "sContent": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/customfiltertemplates" -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 {\"sPageName\": \"string\", \"sDescription\": \"string\", \"bGlobal\": true, \"sContent\": \"string\"}"

Response

200 (OK) : The ID of the new custom filter template

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}: /customfiltertemplates/{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 custom filter template
 Integer

Request body

{
  "sPageName": "string", 
"sDescription": "string", 
"bGlobal": true, 
"sContent": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/customfiltertemplates/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 {\"sPageName\": \"string\", \"sDescription\": \"string\", \"bGlobal\": true, \"sContent\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


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

Curl example

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



Object

Custom Filter Template
 Name
 Description
 Type
sPageName
 Page Name
 String
sDescription
 Description
 String
bGlobal
 Global
Bool
 sContent
 Content
 String