Info

Created 31-08-2020 by Lavinia Gheghea

Revision

--

Description

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

Endpoints


GET:  /batchjobs?sAction=xxxx&nBatchID=1&sEmployeeCode=xxxx


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 : SELECT,  EXECUTE, BATCHJOB, EMPLOYEE
 String
 nBatchID
 ID of the batch
 Integer
 sEmployeeCode
 Code of the employee
 string

Curl example

curl -X GET "https://smartapi.smarttid.dk/batchjobs?sAction=xxxx&nBatchID=x&sEmployeeCode=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) : 
-array of batchjob on Select action 

Response body
[ 
{
    "ID": 11,
    "BatchID": 1,
    "Language": null,
    "Description": "test",
    "StoredProcedure": null,
    "Delimitations": null,
    "Active": true,
    "CaptionShowEmployee": "test",
    "CaptionRefreshEmployee": "test",
    "CaptionExecute": "test"
  },
]

- array of employee on EMPLOYEE action

Response body
[
  {
    "EmployeeCode": "9999",
    "Name": "Test",
    "DepartmentCode": "GERMANY",
    "ProfileCode": "FUNK_FLEX",
    "WorkCalendarCode": null,
    "JournalCode": "FUNK",
    "EMail": "demo@smarttid.dk",
    "Phone": "111111",
    "City": "city",
    "Employed": true,
    "DimensionCode1": null,
    "DimensionCode2": null,
    "DimensionCode3": null,
    "DimensionCode4": null,
    "DimensionCode5": null,
    "DimensionCode6": null,
    "DimensionCode7": null,
    "DimensionCode8": null,
    "DimensionCode9": null,
    "DimensionCode10": 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} : /batchjobs/{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 batchjob
 Integer
Curl example

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

Response

200 (OK) : the batchjob

Response Body
[ 
 { 
"ID": 11, 
"BatchID": 1, 
"Language": null, 
"Description": "test", 
"StoredProcedure": null, 
"Delimitations": null, 
"Active": true, 
"CaptionShowEmployee": "test", 
"CaptionRefreshEmployee": "test", 
"CaptionExecute": "test" 
}
]

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


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
{
 "nBatchID": 0,
  "sLanguage": "string",
  "sDescription": "string",
  "sStoredProcedure": "string",
  "sDelimitations": "string",
  "bActive": true,
  "sCaptionShowEmployee": "string",
  "sCaptionExecute": "string",
  "sCaptionRefreshEmployee": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/batchjobs" -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 "{\"nBatchID\": 0,\"sLanguage\": \"string\",\"sDescription\": \"string\",\"sStoredProcedure\": \"string\",\"sDelimitations\": \"string\",\"bActive\": true,\"sCaptionShowEmployee\": \"string\",\"sCaptionExecute\": \"string\",\"sCaptionRefreshEmployee\": \"string\"}"

Response

200 (OK) : The ID of the new batchjob

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}: /batchjobs/{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 batchjob
 Integer

Request body
{
  "nBatchID": 0, 
"sLanguage": "string", 
"sDescription": "string", 
"sStoredProcedure": "string", 
"sDelimitations": "string", 
"bActive": true, 
"sCaptionShowEmployee": "string", 
"sCaptionExecute": "string", 
"sCaptionRefreshEmployee": "string"
}

Curl example

curl -X PUT "https://smartapi.smarttid.dk/batchjobs/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 "{\"nBatchID\": 0,\"sLanguage\": \"string\",\"sDescription\": \"string\",\"sStoredProcedure\": \"string\",\"sDelimitations\": \"string\",\"bActive\": true,\"sCaptionShowEmployee\": \"string\",\"sCaptionExecute\": \"string\",\"sCaptionRefreshEmployee\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /batchjobs/{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 batchjob
 Integer

Curl example

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


BatchJob

 Name
 Description
 Type
nBatchID
 BatchID
 Integer
 sLanguage
 Language
 string (2)
sDescription
 Description
 String
 sStoredProcedure
 Name of the stored Procedure to be executed in batch job
 String
 sDelimitations
 Filter
 String
 bActive
 Active
 bool
 sCaptionShowEmployee
 Caption Show Employee
 string
 sCaptionExecute
 Caption Execute
 string
 sCaptionRefreshEmployee
 Caption Refresh employee
 string