Info

Created 05-10-2020 by Lavinia Gheghea

Revision



Description

The API allows you to retrieve individual employee job ledger entry as well as a list of all employee job ledger entries.

Endpoints


GET:  /employeejobledgerentries?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
 sEmployeeCode- required
 Employee Code
 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

Curl example

curl -X GET "https://smartapi.smarttid.dk/employeejobledgerentries?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 employee job ledger entries

Response body

{ "ID": 715, "EmployeeCode": "1009", "Name": "Test", "Day": "Ons", "Year": 2019, "Month": 6, "Date": "2019-06-19T00:00:00", "JobCode": "100", "JobDescription": "SmartTID testjob", "JobOperationLineNumber": 10, "OperationCode": "ARBEJDE", "OperationDescription": "Arbejde", "ActivityCode": "FAKTURERBAR", "ActivityDescription": "Fakturerbart", "Transfered": false, "WorkTypeCode": "NORMAL", "StartTime": "2019-06-19T08:00:00", "EndTime": "2019-06-19T12:00:00", "TotalTime": 4, "ERPReference": null, "WorkFunctionCode": "", "DistrictCode": "", "DepartmentCode": "ROMANIA", "EmployeeGroupCode": "", "JournalCode": "STANDARD", "DimensionCode1": "", "DimensionCode2": "", "DimensionCode3": null, "DimensionCode4": null, "DimensionCode5": null, "DimensionCode6": null, "DimensionCode7": null, "DimensionCode8": null, "DimensionCode9": null, "DimensionCode10": null, "PayrollTypeCode": "", "OverTimeCode": null, "Remarks": "", "KMStart": null, "KMEnd": null, "KMTotal": null, "AttachmentJobJournalExists": false, "JournalLineEntryGPSExists": false, "SearchField": "Ons 2019 19-06-2019 NORMAL ROMANIA STANDARD 100 SmartTID testjob ARBEJDE Arbejde FAKTURERBAR Fakturerbart" }, { "ID": 6, "EmployeeCode": "1009", "Name": "Test", "Day": "Tir", "Year": 2018, "Month": 7, "Date": "2018-07-03T00:00:00", "JobCode": "100", "JobDescription": "SmartTID testjob", "JobOperationLineNumber": 10, "OperationCode": "ARBEJDE", "OperationDescription": "Arbejde", "ActivityCode": "FAKTURERBAR", "ActivityDescription": "Fakturerbart", "Transfered": false, "WorkTypeCode": "NORMAL", "StartTime": "2018-07-03T10:00:00", "EndTime": "2018-07-03T18:00:00", "TotalTime": 7.5, "ERPReference": null, "WorkFunctionCode": "", "DistrictCode": "", "DepartmentCode": "ROMANIA", "EmployeeGroupCode": "", "JournalCode": "standard", "DimensionCode1": "", "DimensionCode2": "", "DimensionCode3": "", "DimensionCode4": "", "DimensionCode5": "", "DimensionCode6": "", "DimensionCode7": "", "DimensionCode8": "", "DimensionCode9": null, "DimensionCode10": null, "PayrollTypeCode": "", "OverTimeCode": null, "Remarks": "test", "KMStart": null, "KMEnd": null, "KMTotal": null, "AttachmentJobJournalExists": false, "JournalLineEntryGPSExists": false, "SearchField": "Tir 2018 03-07-2018 NORMAL test ROMANIA standard 100 SmartTID testjob ARBEJDE Arbejde FAKTURERBAR Fakturerbart" }, ]


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} : /employeejobledgerentries/{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 employee job ledger entry
 Integer
Curl example

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

Response

200 (OK) : the employee job ledger entry

Response Body

 { "ID": 6, "EmployeeCode": "1009", "Name": "Test", "Day": "Tir", "Year": 2018, "Month": 7, "Date": "2018-07-03T00:00:00", "JobCode": "100", "JobDescription": "SmartTID testjob", "JobOperationLineNumber": 10, "OperationCode": "ARBEJDE", "OperationDescription": "Arbejde", "ActivityCode": "FAKTURERBAR", "ActivityDescription": "Fakturerbart", "Transfered": false, "WorkTypeCode": "NORMAL", "StartTime": "2018-07-03T10:00:00", "EndTime": "2018-07-03T18:00:00", "TotalTime": 7.5, "ERPReference": null, "WorkFunctionCode": "", "DistrictCode": "", "DepartmentCode": "ROMANIA", "EmployeeGroupCode": "", "JournalCode": "standard", "DimensionCode1": "", "DimensionCode2": "", "DimensionCode3": "", "DimensionCode4": "", "DimensionCode5": "", "DimensionCode6": "", "DimensionCode7": "", "DimensionCode8": "", "DimensionCode9": null, "DimensionCode10": null, "PayrollTypeCode": "", "OverTimeCode": null, "Remarks": "test", "KMStart": null, "KMEnd": null, "KMTotal": null, "AttachmentJobJournalExists": false, "JournalLineEntryGPSExists": false, "SearchField": "Tir 2018 03-07-2018 NORMAL test ROMANIA standard 100 SmartTID testjob ARBEJDE Arbejde FAKTURERBAR Fakturerbart" }
]

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