Info

Created 29-07-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /filtertables

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
 nFilterID
 Filter ID
 String
Curl example

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

Response

200 (OK) :  array of filter tables
Response body
[
{
    "ID": 7,
    "FilterID": 3,
    "ObjectID": 979846903,
    "RecordID": 14
  },
  {
    "ID": 8,
    "FilterID": 3,
    "ObjectID": 979846903,
    "RecordID": 14
  },
  {
    "ID": 9,
    "FilterID": 3,
    "ObjectID": 558793944,
    "RecordID": 1
  },
  {
    "ID": 10,
    "FilterID": 3,
    "ObjectID": 558793944,
    "RecordID": 2
  },
  {
    "ID": 11,
    "FilterID": 3,
    "ObjectID": 558793944,
    "RecordID": 3
  },
  {
    "ID": 12,
    "FilterID": 4,
    "ObjectID": 1458104235,
    "RecordID": 25113
  },
]


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} : /filtertables/{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 table
 Integer
Curl example

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

Response

200 (OK) : the filter table

Response Body
[ 
{ 
"ID": 12, 
"FilterID": 4, 
"ObjectID": 1458104235, 
"RecordID": 25113 
},
]


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


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
{
  "nFilterID": 0,
  "nObjectID": 0,
  "nRecordID": 0,
  "sColorCode": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/filtertables" -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 { \"nFilterID\": 0, \"nObjectID\": 0, \"nRecordID\": 0,  \"sColorCode\": \"string\"}"

Response

200 (OK) : The ID of the new filter table

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}: /filtertables/{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 table
 Integer

Request body


{ 
"nFilterID": 0,
"nObjectID": 0, 
"nRecordID": 0, 
"sColorCode": "string" 
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/filtertables/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 { \"nFilterID\": 0, \"nObjectID\": 0, \"nRecordID\": 0,  \"sColorCode\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /filtertables/{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 table
 Integer

Curl example

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

Object

Filter Table
 Name
 Description
 Type
nFilterID
 Filter ID
 integer
nObjectID
 Object ID
 Integer
 nRecordID
 Record ID
Integer
 sColorCode
 Color Code
String