Info

Created 22-09-2020 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /bookingtypes


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
 sAction
 Action other than Select
 String

Curl example

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

Response

200 (OK) :  array of booking type

Response body
[ 
 {
    "ID": 4,
    "BookingTypeCode": "PLANE",
    "Description": "Travel out and home ny plane",
    "ColorCode": "BLÅ",
    "Type": "Both",
    "PeriodDays": 1,
    "Visible": true
  },
  {
    "ID": 5,
    "BookingTypeCode": "HOTEL",
    "Description": "Hotel",
    "ColorCode": "GRØN",
    "Type": "Period",
    "PeriodDays": 1,
    "Visible": 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} : /bookingtypes/{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 booking type
 Integer
Curl example

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

Response

200 (OK) : the booking type

Response Body
[ 
 {
    "ID": 4,
    "BookingTypeCode": "PLANE",
    "Description": "Travel out and home ny plane",
    "ColorCode": "BLÅ",
    "Type": "Both",
    "PeriodDays": 1,
    "Visible": 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: /bookingtypes


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
{
  "sBookingTypeCode": "string",
  "sDescription": "string",
  "sColorCode": "string",
  "sType": "string",
  "nPeriodDays": 0,
  "bVisible": true
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/bookingtypes" -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 "{ \"sBookingTypeCode\": \"string\", \"sDescription\": \"string\", \"sColorCode\": \"string\", \"sType\": \"string\", \"nPeriodDays\": 0, \"bVisible\": true }"

Response

200 (OK) : The ID of the new booking type

Response Body
[
 {
  "ID": 25033
 }
]
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}: /bookingtypes/{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 bookingtype
 Integer

Request body

{
  "sBookingTypeCode": "string",
  "sDescription": "string",
  "sColorCode": "string",
  "sType": "string",
  "nPeriodDays": 0,
  "bVisible": true
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/bookingtypes/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 "{ \"sBookingTypeCode\": \"string\", \"sDescription\": \"string\", \"sColorCode\": \"string\", \"sType\": \"string\", \"nPeriodDays\": 0, \"bVisible\": true }"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /bookingtypes/{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 bookingtype
 Integer

Curl example

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

Booking Type
 Name
 Description
 Type
sBookingTypeCode
 Code of booking type
 String
sDescription
 Description
 String
 sColorCode
 Color
 String
 sType
 Type
 String
 nPeriodDays
 Period Days
 number(integer)
 bVisible
 Visible
 bool