Info

Created 31-08-2020 by Lavinia Gheghea

Revision

--

Description

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

Endpoints


GET:  /dimensions


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

Curl example

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

Response

200 (OK) :  array of dimension

Response body
[ 
{
    "ID": 3,
    "DimensionNumber": 1,
    "LanguageCode": "DK",
    "FieldName": "Bil",
    "AvailableEmployee": true,
    "AvailableJournalLineEntry": true,
    "AvailableWorkType": true,
    "AvailableJob": true,
    "AvailableJobJournal": true,
    "FixedValues": true,
    "RelateToDimensionNumber": null
  },
  {
    "ID": 4,
    "DimensionNumber": 1,
    "LanguageCode": "EN",
    "FieldName": "Car",
    "AvailableEmployee": true,
    "AvailableJournalLineEntry": true,
    "AvailableWorkType": true,
    "AvailableJob": true,
    "AvailableJobJournal": true,
    "FixedValues": true,
    "RelateToDimensionNumber": null
  },
]


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} : /dimensions/{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 dimension
 Integer
Curl example

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

Response

200 (OK) : the dimension

Response Body
[ 
 { 
"ID": 4, 
"DimensionNumber": 1, 
"LanguageCode": "EN", 
"FieldName": "Car", 
"AvailableEmployee": true, 
"AvailableJournalLineEntry": true, 
"AvailableWorkType": true, 
"AvailableJob": true, 
"AvailableJobJournal": true, 
"FixedValues": true, 
"RelateToDimensionNumber": null 
},
]

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


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
{
  "nDimensionNumber": 0,
  "sFieldName": "string",
  "sLanguageCode": "string",
  "bAvailableEmployee": true,
  "bAvailableJournalLineEntry": true,
  "bAvailableWorkType": true,
  "bAvailableJob": true,
  "bAvailableJobJournal": true,
  "bFixedValues": true
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/dimensions" -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 "{\"nDimensionNumber\": 0,\"sFieldName\": \"string\",\"sLanguageCode\": \"string\",\"bAvailableEmployee\": true,\"bAvailableJournalLineEntry\": true,\"bAvailableWorkType\": true,\"bAvailableJob\": true,\"bAvailableJobJournal\": true,\"bFixedValues\": true}"

Response

200 (OK) : The ID of the new dimension

Response Body
[
 {
  "ID": 5
  }
]
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}: /dimensions/{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 dimension
 Integer

Request body
{
  "nDimensionNumber": 0,
 "sFieldName": "string",
 "sLanguageCode": "string", 
"bAvailableEmployee": true, 
"bAvailableJournalLineEntry": true, 
"bAvailableWorkType": true, 
"bAvailableJob": true, 
"bAvailableJobJournal": true, 
"bFixedValues": true
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/dimensions/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 "{\"nDimensionNumber\": 0,\"sFieldName\": \"string\",\"sLanguageCode\": \"string\",\"bAvailableEmployee\": true,\"bAvailableJournalLineEntry\": true,\"bAvailableWorkType\": true,\"bAvailableJob\": true,\"bAvailableJobJournal\": true,\"bFixedValues\": true}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /dimensions/{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 dimension
 Integer

Curl example

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


Object


Dimension
 Name
 Description
 Type
nDimensionNumber
 Dimension Number
Integer
sFieldName
 Name of dimension
 String
 sLanguageCode
 Language
 String(2) 
 bAvailableEmployee
 Available on Employee
 bool
 bAvailableJournaLineEntry
 Available on Journal Line Entry
 bool
 bAvailableWorkType
 Available on Work Type
 bool
 bAvailableJob
 Available on Job
 bool
 bAvailableJobJournal
 Available on Job Journal
 bool
 bFixedValues
 Fixed Values
 bool