Info

Created 14-10-2020 by Lavinia Gheghea

Revision



Description

The API allows you to get job ledger analyses

Endpoints


GET:  /jobledgeranalyses


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

Curl example

curl -X GET "https://smartapi.smarttid.dk/jobledgeranalyses?dtStartDate=xxxxx&dtEndDate=xxxx" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :  array of job ledger analyses

Response body
[  
{
    "EmployeeCode": "5264",
    "Date": "13-05-2020",
    "JobCode": "100",
    "JobDescription": "SmartTID testjob",
    "JobOperationLineNumber": 10,
    "OperationCode": "ARBEJDE",
    "OperationDescription": "Arbejde",
    "ActivityCode": "FAKTURERBAR",
    "ActivityDescription": "Fakturerbart",
    "OriginalOperationDescription": "Arbejde",
    "OriginalActivityDescription": "Fakturerbart",
    "Name": "Empl1",
    "Employee": "5264 Empl1",
    "Transfered": false,
    "Completed": false,
    "WorkTypeCode": "NORMALF",
    "StartTime": "10:49",
    "EndTime": "10:55",
    "TotalTime": 0.1,
    "TimeLedgerEntryID": null,
    "ERPReference": null,
    "TaskID": null,
    "WorkFunctionCode": "",
    "DepartmentCode": "",
    "Setup": false,
    "JournalCode": "FUNK",
    "Day": "Ons",
    "Month": 5,
    "Year": 2020,
    "Remark": "",
    "WorkCalendarCode": "FUNK",
    "Job": "100 SmartTID testjob",
    "ShortDescription": null,
    "Subject": null,
    "Quantity": 0,
    "JobGroupCode": "3",
    "DimensionCode1": "",
    "DimensionCode2": "",
    "DimensionCode3": null,
    "DimensionCode4": null,
    "DimensionCode5": null,
    "DimensionCode6": null,
    "DimensionCode7": null,
    "DimensionCode8": null,
    "DimensionCode9": null,
    "DimensionCode10": null,
    "KMStart": null,
    "KMEnd": null,
    "KMTotal": null,
    "CustomerCode": null,
    "CustomerName": null,
    "PlannedTime": null,
    "OperationCompleted": false,
    "Status": "Started",
    "EmployeeGroupCode": "",
    "OperationGroupCode": "",
    "Invoiced": false,
    "PlannedDeliveryDate": null,
    "ActualDeliveryDate": null
  },
  {
    "EmployeeCode": "1003",
    "Date": "09-04-2020",
    "JobCode": "100",
    "JobDescription": "SmartTID testjob",
    "JobOperationLineNumber": 10,
    "OperationCode": "ARBEJDE",
    "OperationDescription": "Arbejde",
    "ActivityCode": "FAKTURERBAR",
    "ActivityDescription": "Fakturerbart",
    "OriginalOperationDescription": "Arbejde",
    "OriginalActivityDescription": "Fakturerbart",
    "Name": "Empl2",
    "Employee": "1003 Empl2",
    "Transfered": false,
    "Completed": false,
    "WorkTypeCode": "NORMAL",
    "StartTime": "07:00",
    "EndTime": "16:00",
    "TotalTime": 9,
    "TimeLedgerEntryID": null,
    "ERPReference": null,
    "TaskID": null,
    "WorkFunctionCode": "",
    "DepartmentCode": "DENMARK",
    "Setup": false,
    "JournalCode": "TIME",
    "Day": "Tor",
    "Month": 4,
    "Year": 2020,
    "Remark": "",
    "WorkCalendarCode": "DAG2",
    "Job": "100 SmartTID testjob",
    "ShortDescription": null,
    "Subject": null,
    "Quantity": 0,
    "JobGroupCode": "3",
    "DimensionCode1": "BMW",
    "DimensionCode2": "37",
    "DimensionCode3": "",
    "DimensionCode4": null,
    "DimensionCode5": null,
    "DimensionCode6": null,
    "DimensionCode7": null,
    "DimensionCode8": null,
    "DimensionCode9": null,
    "DimensionCode10": null,
    "KMStart": null,
    "KMEnd": null,
    "KMTotal": null,
    "CustomerCode": null,
    "CustomerName": null,
    "PlannedTime": null,
    "OperationCompleted": false,
    "Status": "Started",
    "EmployeeGroupCode": "",
    "OperationGroupCode": "",
    "Invoiced": false,
    "PlannedDeliveryDate": null,
    "ActualDeliveryDate": 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":x,"totalFiltered":x,"Offset":0,"Limit":x,"Returned":x} 
 x-powered-by: ASP.NET

400 (ERROR) : Error message

Response Body
Error message