General Description

HTTP method	API version
PUT	v1

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

API Path: /Employees/{id}
or
API Path: /Employees/{id}/Anonimize
or
API Path: /Employees/{id}/note_plain

You make this API call with the key field id as the path parameter (the id of the Employee you want to update)

Fields

The following fields are available:

Field Name	Type
id	Number
groups	String
date_in_service	String
date_no_longer_in_service	String
active	Boolean
ts_lastupdate	String
name	String
address	String
countrycode	String
zipcode	String
city	String
state	String

/Employees/{id}

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 there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

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/Employees/532

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: date_no_longer_in_service=’2018–05–14’

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 532,
    "groups": "Niet actief",
    "date_in_service": "2018–05–14",
    "date_no_longer_in_service": "2018–05–14",
    "active": false,
    "ts_lastupdate": "2025–02–12 14:28:44"
  }
]
}

https://ra.bouwsoft.be/api/v1/Employees/532

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: gender=’M‘,address=’matongewijk 17’,countrycode=’BE‘,zipcode=’1000’,city=’Brussel’

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 532,
    "address": "matongewijk 17",
    "countrycode": "BE",
    "zipcode": "1000",
    "city": "Brussel 1",
    "state": "Brussels Hoofdstedelijk Gewest",
    "ts_lastupdate": "2025–02–12 14:28:02"
  }
]
}

/Employees/{id}/Anonimize

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 there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

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/Employees/532/Anonimize

with the following parameters :

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

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 532,
    "name": "W.A",
    "address": "M."
  }
]
}

/Employees/{id}/note_plain

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 there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

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/Employees/532/note_plain

with the following parameters :

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

Body Parameters :
Employee test note_plain

Success gives statuscode 200 And the following result

Employee test note_plain