Info
Created 22-01-2020 by Lavinia
Gheghea
Revision
09-05-2022 LG - Remove nID and sIDList from Parameters and added Request Body with Json Object .Updated the cUrl examples
10-05-2022 LG - Readded nID and sIDList as Query Parameter and added Request Body with Json Object with sIDList that can be used in case want to mark a lot of entries in the same batch( more than 500 IDs)- string length greater than 2048 chars .Update cUrl examples
Description
The API
allows you to mark a job ledger entry as transfered.You can mark one job ledger entry as transfered by sending the ID(nID) or many job ledger entries as transfered by sending the list of IDs(sIDList)
Endpoints
POST: /markjobledgerentrytransfered
Parameters
Name | Description | Type |
API-key - required | Authorization Token | String(64) |
UID - required | UID -how can
be obtained | String |
DEVICEID - required | DEVICEID | String |
nID | ID of Job Ledger entry | Integer |
sIDList | List of IDs of Job Ledger Entries | String |
Request body
{ "sIDList": "string" }
Examples:
Curl example to mark a single job ledger entry with single ID
curl -X POST "https://smartapi.smarttid.dk/markjobledgerentrytransfered?nID=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -d "{}"
Curl example with multiple IDs - string length less than 2048 chars
curl -X POST "https://smartapi.smarttid.dk/markjobledgerentrytransfered?sIDList=ID1,ID2,ID3,....." -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -d "{}"
New update
If you want to mark a lot of entries in the same batch( more than 500 IDs) you have to use Request Body object like in the following example:
Curl example with multiple IDs - string length greater than 2048 chars
curl -X POST "https://smartapi.smarttid.dk/markjobledgerentrytransfered" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -d "{ \"sIDList\": \"ID1,ID2,ID3,.....ID1600.....\"}"
Response
200 (OK) : Success message
Response Body
Success message
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