Info

Created 14-10-2020 by Lavinia Gheghea

Revision



Description

The API allows you to get dimension value

Endpoints


GET:  /getdimensionvalue


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
 sEmployeeCode
 Employee Code
 String
 nDimensionNumber
 Dimension Number
 Integer
 sDimensionCode1
 Dimension Code 1
 String
 sDimensionCode2
 Dimension Code 2
 String
 sDimensionCode3
 Dimension Code 3
 String
 sDimensionCode4
 Dimension Code 4
 String
 sDimensionCode5
 Dimension Code 5
 String
 sDimensionCode6
 Dimension Code 6
 String
 sDimensionCode7
 Dimension Code 7
 String
 sDimensionCode8
 Dimension Code 8
 String
 sDimensionCode9
 Dimension Code 9
 String
 sDimensionCode10
 Dimension Code 10
 String

Curl example

curl -X GET "https://smartapi.smarttid.dk/getdimensionvalue?sEmployeeCode=xxxx&nDimensionNumber=xxxx&sDimensionCode1=xxxx&sDimensionCode2=xxxx&sDimensionCode3=xxxx&sDimensionCode4=xxxx&sDimensionCode5=xxxx&sDimensionCode6=xxxx&sDimensionCode7=xxxx&sDimensionCode8=xxxx&sDimensionCode9=xxxx&sDimensionCode10=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :  array of dimensions

Response body
[ 
 {
    "DimensionCode": "BMW",
    "Description": "BMW"
  },
  {
    "DimensionCode": "FORD",
    "Description": "Ford"
  },
  {
    "DimensionCode": "OPEL",
    "Description": "Opel"
  },
  {
    "DimensionCode": "Test",
    "Description": "a1234"
  }
]



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

SQL Procedure 

sp_GetDimensionValue