Info
Created 12-02-2021 by Lavinia
Gheghea
Revision
Description
The API
allows you to get the system setup and also to update system setup.
Endpoints
GET: /systemsetups
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 |
Curl example
curl -X GET "https://smartapi.smarttid.dk/systemsetups" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) : system setup
Response body
[{ "AutoInsertEmployee": true, "AutoInsertAbsence": true, "AutoInsertNonWorkingDay": true, "AutoApprove": false, "DefaultLanguageCode": "DK", "JobTimeActive": true, "AgreementActive": false, "DimensionActive": false, "TeamsActive": true, "ShowEmployeesAtWorkOnLogin": false, "ShowAbsenceOnLogin": false, "UseOnlyTAG": false, "TAGDelayTime": "2021-02-03T00:05:00", "AssignTAGOnLogin": false, "ShowOutForBreak": false, "UnlockPassword": "5024", "DontShowAbcenseCode": false, "ShowEmailOnAtWorkList": false, "ShowCellPhoneOnAtWorkList": true, "ShowPlannedTime": true, "ShowUsedTime": false, "ShowProducedQuantity": false, "AutoStopJobs": false, "PostExtraOnJobs": true, "CalculatePaidBreaksInJobTime": false, "AjustFirstJobStartToWorkStart": false, "SplitTimeOnOperations": false, "CompleteJobOnLastOperationComplete": false, "JobTimeMustMatchWorkTime": false, "IncludeNonPostetTimeInUsedTime": false, "JobSortOrder": "", "CalculateBreaksInJobTime": false, "UseMailFunctionality": false, "DefaultMailReceiver": "", "UseMailOnNewAbsence": false, "SendMailOnPostAbsence": false, "CompanyName": "test2", "CompanyAddress": "", "CompanyZipCode": "", "CompanyCity": "", "CompanyPhone": "", "CompanyContact": "", "CompanyEMail": "", "ProcedureOnJournalPost": "", "ProcedureOnCreateEmployee": "", "ProcedureOnJournalLinePost": "", "ProcedureOnLogin": "", "ProcedureOnJournalLineApprove": "", "ProcedureOnUpdateEmployee": "", "ProcedureOnLoginJob": "", "ProcedureOnNewJournalLine": "", "ProcedureOnJournalLineEntryUpdate": "", "SmartTIDCustomerID": 1029, "TimeSheetWeeksBack": 3, "TimeSheetShowTasks": true, "EvacuationWorkTypeCode": null, "EvacuationRemark": null, "VacationDaysWorkTypeCode": "FERIEOP", "VacationHoursWorkTypeCode": "FERIEFRIOP" } ]
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
POST: /systemsetups
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
{ "bAutoInsertEmployee": true, "bAutoInsertAbsence": true, "bAutoInsertNonWorkingDay": true, "bAutoApprove": true, "sDefaultLanguageCode": "string", "bUseOnlyTAG": true, "bJobTimeActive": true, "bShowEmployeesAtWorkOnLogin": true, "bShowAbsenceOnLogin": true, "bShowPlannedTime": true, "bShowUsedTime": true, "bShowProducedQuantity": true, "bAutoStopJobs": true, "bUseMailFunctionality": true, "sDefaultMailReceiver": "string", "bUseMailOnNewAbsence": true, "bSendMailOnPostAbsence": true, "dtTAGDelayTime": "string", "sCompanyName": "string", "sCompanyAddress": "string", "sCompanyZipCode": "string", "sCompanyCity": "string", "sCompanyPhone": "string", "sCompanyContact": "string", "sCompanyEMail": "string", "bPostExtraOnJobs": true, "sProcedureOnJournalPost": "string", "bCalculatePaidBreaksInJobTime": true, "bAjustFirstJobStartToWorkStart": true, "bSplitTimeOnOperations": true, "bCompleteJobOnLastOperationComplete": true, "bAssignTAGOnLogin": true, "bShowOutForBreak": true, "sProcedureOnCreateEmployee": "string", "sProcedureOnJournalLinePost": "string", "sProcedureOnLogin": "string", "sProcedureOnJournalLineApprove": "string", "sProcedureOnUpdateEmployee": "string", "sProcedureOnLoginJob": "string", "sProcedureOnNewJournalLine": "string", "sProcedureOnJournalLineEntryUpdate": "string", "bJobTimeMustMatchWorkTime": true, "nSmartTIDCustomerID": 0, "sUnlockPassword": "string", "bIncludeNonPostetTimeInUsedTime": true, "sJobSortOrder": "string", "bCalculateBreaksInJobTime": true, "nTimeSheetWeeksBack": 0, "bDontShowAbcenseCode": true, "bShowEmailOnAtWorkList": true, "sEvacuationWorkTypeCode": "string", "sEvacuationRemark": "string", "bAgreementActive": true, "bDimensionActive": true, "sVacationDaysWorkTypeCode": "string", "sVacationHoursWorkTypeCode": "string", "bTeamsActive": true, "bShowCellPhoneOnAtWorkList": true, "bTimeSheetShowTasks": true }
Curl example
curl -X POST "https://smartapi.smarttid.dk/systemsetups" -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 {\"bAutoInsertEmployee\": true, \"bAutoInsertAbsence\": true, \"bAutoInsertNonWorkingDay\": true, \"bAutoApprove\": true, \"sDefaultLanguageCode\": \"string\", \"bUseOnlyTAG\": true, \"bJobTimeActive\": true, \"bShowEmployeesAtWorkOnLogin\": true, \"bShowAbsenceOnLogin\": true, \"bShowPlannedTime\": true, \"bShowUsedTime\": true, \"bShowProducedQuantity\": true, \"bAutoStopJobs\": true, \"bUseMailFunctionality\": true, \"sDefaultMailReceiver\": \"string\", \"bUseMailOnNewAbsence\": true, \"bSendMailOnPostAbsence\": true, \"dtTAGDelayTime\": \"string\", \"sCompanyName\": \"string\", \"sCompanyAddress\": \"string\", \"sCompanyZipCode\": \"string\", \"sCompanyCity\": \"string\", \"sCompanyPhone\": \"string\", \"sCompanyContact\": \"string\", \"sCompanyEMail\": \"string\", \"bPostExtraOnJobs\": true, \"sProcedureOnJournalPost\": \"string\", \"bCalculatePaidBreaksInJobTime\": true, \"bAjustFirstJobStartToWorkStart\": true, \"bSplitTimeOnOperations\": true, \"bCompleteJobOnLastOperationComplete\": true, \"bAssignTAGOnLogin\": true, \"bShowOutForBreak\": true, \"sProcedureOnCreateEmployee\": \"string\", \"sProcedureOnJournalLinePost\": \"string\", \"sProcedureOnLogin\": \"string\", \"sProcedureOnJournalLineApprove\": \"string\", \"sProcedureOnUpdateEmployee\": \"string\", \"sProcedureOnLoginJob\": \"string\", \"sProcedureOnNewJournalLine\": \"string\", \"sProcedureOnJournalLineEntryUpdate\": \"string\", \"bJobTimeMustMatchWorkTime\": true, \"nSmartTIDCustomerID\": 0, \"sUnlockPassword\": \"string\", \"bIncludeNonPostetTimeInUsedTime\": true, \"sJobSortOrder\": \"string\", \"bCalculateBreaksInJobTime\": true, \"nTimeSheetWeeksBack\": 0, \"bDontShowAbcenseCode\": true, \"bShowEmailOnAtWorkList\": true, \"sEvacuationWorkTypeCode\": \"string\", \"sEvacuationRemark\": \"string\", \"bAgreementActive\": true, \"bDimensionActive\": true, \"sVacationDaysWorkTypeCode\": \"string\", \"sVacationHoursWorkTypeCode\": \"string\", \"bTeamsActive\": true, \"bShowCellPhoneOnAtWorkList\": true, \"bTimeSheetShowTasks\": true}"
Response
200 (OK) :Success
400 (ERROR) : Error message
Response Body
Error message
Object
System Setup
| Name | Description | Type |
| bAutoInsertEmployee | Auto Insert Employee | bool |
| bAutoInsertAbsence | Auto Insert Absence | bool |
| bAutoInsertNonWorkingDay | Auto Insert NonWorking Day | bool |
| bAutoApprove | Auto Approve | bool |
| sDefaultLanguageCode | Default Language Code | String |
| bUseOnlyTAG | Use Only TAG | bool |
| bJobTimeActive | Job Time Active | bool |
| bShowEmployeesAtWorkOnLogin | Show Employees At Work On Login | bool |
| bShowAbsenceOnLogin | Show Absence On Login | bool |
| bShowPlannedTime | Show Planned Time | bool |
| bShowUsedTime | Show Used Time | bool |
| bShowProducedQuantity | Show Produced Quantity | bool |
| bAutoStopJobs | Auto Stop Jobs | bool |
| bUseMailFunctionality | Use Mail Functionality | bool |
| sDefaultMailReceiver | Default Mail Receiver | string |
| bUseMailOnNewAbsence | Use Mail On New Absence | bool |
| bSendMailOnPostAbsence | Send Mail On Post Absence | bool |
| dtTAGDelayTime | TAG Delay Time | String |
| sCompanyName | Company Name | String |
| sCompanyAddress | Company Address | String |
| sCompanyZipCode | Company Zip Code | String |
| sCompanyCity | Company City | String |
| sCompanyPhone | Company Phone | String |
| sCompanyContact | Company Contact | String |
| sCompanyEMail | Company EMail | String |
| bPostExtraOnJobs | Post Extra On Jobs | bool |
| sProcedureOnJournalPost | Procedure On Journal Post | String |
| bCalculatePaidBreaksInJobTime | Calculate Paid Breaks In Job Time | bool |
| bAjustFirstJobStartToWorkStart | Ajust First Job Start To Work Start | bool |
| bSplitTimeOnOperations | Split Time On Operations | bool |
| bCompleteJobOnLastOperationComplete | Complete Job On Last Operation Complete | bool |
| bAssignTAGOnLogin | Assign TAG On Login | bool |
| bShowOutForBreak | Show Out For Break | bool |
| sProcedureOnCreateEmployee | Procedure On Create Employee | string |
| sProcedureOnJournalLinePost | Procedure On Journal Line Post | string |
| sProcedureOnLogin | Procedure On Login | string |
| sProcedureOnJournalLineApprove | Procedure On Journal Line Approve | string |
| sProcedureOnUpdateEmployee | Procedure On Update Employee | string |
| sProcedureOnLoginJob | Procedure On Login Job | string |
| sProcedureOnNewJournalLine | Procedure On New Journal Line | String |
| sProcedureOnJournalLineEntryUpdate | Procedure On Journal Line Entry Update | String |
| bJobTimeMustMatchWorkTime | Job Time Must Match Work Time | bool |
| nSmartTIDCustomerID | SmartTID Customer ID | Integer |
| sUnlockPassword | Unlock Password | String |
| bIncludeNonPostetTimeInUsedTime | Include Non Postet Time In Used Time | bool |
| sJobSortOrder | Job Sort Order | string |
| bCalculateBreaksInJobTime | Calculate Breaks In Job Time | bool |
| nTimeSheetWeeksBack | Time Sheet Weeks Back | integer |
| bDontShowAbcenseCode | Dont Show Abcense Code | bool |
| bShowEmailOnAtWorkList | Show Email On At Work List | bool |
| sEvacuationWorkTypeCode | Evacuation Work Type Code | string |
| sEvacuationRemark | Evacuation Remark | string |
| bAgreementActive | Agreement Active | bool |
| bDimensionActive | Dimension Active | bool |
| sVacationDaysWorkTypeCode | Vacation Days Work Type Code | string |
| sVacationHoursWorkTypeCode | Vacation Hours Work Type Code | string |
| bTeamsActive | Teams Active | bool |
| bShowCellPhoneOnAtWorkList | Show CellPhone On At Work List | bool |
| bTimeSheetShowTasks | Time Sheet Show Tasks | bool |