This API call is used to get fields of a(n) Setting(s)

HTTP method	API version
GET	v1

Don’t forget to put the Authorization field in the header

API Path: /Settings/

You make this API call:
* to get the result of Settings

Fields

The following fields are available:

Field Name	Type
Documents.ActualCosts.Equipment.Start	Number
Documents.ActualCosts.Equipment.Stop	Number
Documents.ActualCosts.MobilityPerDay	String
Documents.ActualCosts.TimeWorked.Pause1.Start	String
Documents.ActualCosts.TimeWorked.Pause1.Stop	String
Documents.ActualCosts.TimeWorked.Pause2.Start	String
Documents.ActualCosts.TimeWorked.Pause2.Stop	String
Documents.ActualCosts.TimeWorked.Pause3.Start	String
Documents.ActualCosts.TimeWorked.Pause3.Stop	String
Documents.ActualCosts.TimeWorked.Start	Number
Documents.ActualCosts.TimeWorked.Stop	Number
Documents.Relations.LeadsGroupId	Number
Documents.Relations.ProspectsGroupId	Number
ExtraModule.Time.ShowUnapprovedProjects	Boolean
ExtraModule.WorkOrdersApp.SendEmails	Boolean
Projects.Distance.AutoUpdate	String
User.Language	String

/Settings/

API Path: /Settings/

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/Settings

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: OjlfWxfVlkzSflVbbfzRqUbVfPjDfGGGfDlkzrljODIGUDAbbf

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "Documents.ActualCosts.Equipment.Start": 8.0,
    "Documents.ActualCosts.Equipment.Stop": 17.0,
    "Documents.ActualCosts.MobilityPerDay": "FWA",
    "Documents.ActualCosts.TimeWorked.Pause1.Start": "08:00:00",
    "Documents.ActualCosts.TimeWorked.Pause1.Stop": "08:15:00",
    "Documents.ActualCosts.TimeWorked.Pause2.Start": "12:00:00",
    "Documents.ActualCosts.TimeWorked.Pause2.Stop": "12:30:00",
    "Documents.ActualCosts.TimeWorked.Pause3.Start": "15:00:00",
    "Documents.ActualCosts.TimeWorked.Pause3.Stop": "15:15:00",
    "Documents.ActualCosts.TimeWorked.Start": 0.0,
    "Documents.ActualCosts.TimeWorked.Stop": 0.0,
    "Documents.Relations.LeadsGroupId": 47,
    "Documents.Relations.ProspectsGroupId": 54,
    "ExtraModule.Time.ShowUnapprovedProjects": true,
    "ExtraModule.WorkOrdersApp.SendEmails": true,
    "Projects.Distance.AutoUpdate": "Always",
    "User.Language": "NL"
  }
]
}