Info

Created 25-02-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /teams

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
 String
 dtStartDate
 Start Date
 string
 dtEndDate
 End Date
 string
Curl example

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

Response

200 (OK) :  array of teams

Response body
[ 
{
    "ID": 24,
    "TeamCode": "0001",
    "Name": "Team SmartTID",
    "StartDate": "2020-04-01T00:00:00",
    "EndDate": "2020-12-31T00:00:00",
    "ColorCode": "ORANGE",
    "JobCode": "100",
    "Active": true
  },
  {
    "ID": 25,
    "TeamCode": "0002",
    "Name": "Team 2 SmartTID",
    "StartDate": "2020-04-01T00:00:00",
    "EndDate": "2020-12-31T00:00:00",
    "ColorCode": "PINK",
    "JobCode": "102",
    "Active": true
  },
  {
    "ID": 38,
    "TeamCode": "9",
    "Name": "test",
    "StartDate": null,
    "EndDate": null,
    "ColorCode": null,
    "JobCode": "",
    "Active": false
  },
  {
    "ID": 40,
    "TeamCode": "101",
    "Name": "Test 101+",
    "StartDate": "2020-06-01T00:00:00",
    "EndDate": "2020-10-01T00:00:00",
    "ColorCode": "BLÅ",
    "JobCode": "101+",
    "Active": 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} : /teams/{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 team
 Integer
Curl example

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

Response

200 (OK) : the sql job

Response Body
[ 
{ 
"ID": 40, 
"TeamCode": "101", 
"Name": "Test 101+", 
"StartDate": "2020-06-01T00:00:00", 
"EndDate": "2020-10-01T00:00:00", 
"ColorCode": "BLÅ", 
"JobCode": "101+", 
"Active": 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: /teams


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
{
"sTeamCode": "string",
  "sName": "string",
  "dtStartDate": "string",
  "dtEndDate": "string",
  "sColorCode": "string",
  "sJobCode": "string",
  "bActive": true,
  "sCopyFromTeamCode": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/teams" -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 {\"sTeamCode\": \"string\",  \"sName\": \"string\",  \"dtStartDate\": \"string\",  \"dtEndDate\": \"string\",  \"sColorCode\": \"string\",  \"sJobCode\": \"string\",  \"bActive\": true,  \"sCopyFromTeamCode\": \"string\"}"

Response

200 (OK) : The ID of the new team

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}: /teams/{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 team
 Integer

Request body

{ 
"sTeamCode": "string",
  "sName": "string",
  "dtStartDate": "string",
  "dtEndDate": "string",
  "sColorCode": "string",
  "sJobCode": "string",
  "bActive": true,
  "sCopyFromTeamCode": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/teams/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 {\"sTeamCode\": \"string\",  \"sName\": \"string\",  \"dtStartDate\": \"string\",  \"dtEndDate\": \"string\",  \"sColorCode\": \"string\",  \"sJobCode\": \"string\",  \"bActive\": true,  \"sCopyFromTeamCode\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /teams/{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 team
 Integer

Curl example

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

Team
 Name
 Description
 Type
sTeamCode
 Code of team
 String
sName
 Name
 String
 dtStartDate
 Start Date
String
 dtEndDate
 End Date
 String
 sColorCode
 Color Code
String
 sJobCode
 Job Code
 String
 bActive
 Active 
 bool
 sCopyFromTeamCode
 Copy From Team Code
 string