General Description

HTTP method	API version
POST	v1

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

API Path: /Employees
or
API Path: /Employees/{id}/Upload

Fields

The following fields are available:

Field Name	Type
id	Number
name	String
initials	String
firstname	String
surname	String
username	String
nr	Number
groups	String
address	String
addressline2	String
countrycode	String
zipcode	String
city	String
state	String
telephone	String
fax	String
gsm	String
email	String
company_id	Number
company_name	String
function	String
function_localized	String
date_in_service	String
date_no_longer_in_service	String
date_birth	String
place_birth	String
language	String
gender	String
civil_status	String
civil_status_localized	String
bic	String
iban	String
identity_card_nr	String
national_identity_nr	String
social_security_nr	String
partner_name	String
partner_profession	String
partner_date_of_birth	String
partner_with_disability	Boolean
partner_fiscally_dependent	Boolean
children_with_disability	Number
children_fiscally_dependent	Number
people_with_disability	Number
people_fiscally_dependent	Number
healthcare_fund_name	String
healthcare_fund_registration_nr	String
healthcare_fund_address	String
healthcare_fund_addressline2	String
healthcare_fund_countrycode	String
healthcare_fund_zipcode	String
healthcare_fund_city	String
healthcare_fund_state	String
general_practitioner	String
telephone_emergency	String
contract_start	String
contract_end	String
contract_independent	Boolean
contract_type	String
contract_type_localized	String
classification	String
employment_form	String
employment_form_localized	String
employment_status	String
employment_status_localized	String
personnel_nr	String
dimona_nr	String
drivers_license	Boolean
drivers_license_expire_date	String
acknowledgement_nr_gv	String
acknowledgement_nr_tv	String
acknowledgement_nr_va	String
acknowledgement_nr_sv	String
acknowledgement_g1	Boolean
acknowledgement_g2	Boolean
acknowledgement_l	Boolean
distance_commute	Number
active	Boolean
ts_lastupdate	String
path_display	String
path_lower	String
client_modified	String
server_modified	String
rev	String
size	Number
is_downloadable	Boolean
checksum	String

/Employees

API Path: /Employees/

If everything succeeds the HTTP response status is 201
(201 CREATED)

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

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: name=’WnDirk API‘,firstname=’wnDirk’,surname=’API’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 532,
    "name": "WnDirk API",
    "initials": "",
    "firstname": "wnDirk",
    "surname": "API",
    "username": "",
    "nr": 2018233,
    "groups": "",
    "address": "",
    "addressline2": "",
    "countrycode": "",
    "zipcode": "",
    "city": "",
    "state": "",
    "telephone": "",
    "fax": "",
    "gsm": "",
    "email": "",
    "company_id": 2,
    "company_name": "Groensoft",
    "function": "",
    "function_localized": "",
    "date_in_service": "",
    "date_no_longer_in_service": "",
    "date_birth": "",
    "place_birth": "",
    "language": "Nederlands",
    "gender": "M",
    "civil_status": "",
    "civil_status_localized": "",
    "bic": "",
    "iban": "",
    "identity_card_nr": "",
    "national_identity_nr": "",
    "social_security_nr": "",
    "partner_name": "",
    "partner_profession": "",
    "partner_date_of_birth": "",
    "partner_with_disability": false,
    "partner_fiscally_dependent": false,
    "children_with_disability": 0,
    "children_fiscally_dependent": 0,
    "people_with_disability": 0,
    "people_fiscally_dependent": 0,
    "healthcare_fund_name": "",
    "healthcare_fund_registration_nr": "",
    "healthcare_fund_address": "",
    "healthcare_fund_addressline2": "",
    "healthcare_fund_countrycode": "",
    "healthcare_fund_zipcode": "",
    "healthcare_fund_city": "",
    "healthcare_fund_state": "",
    "general_practitioner": "",
    "telephone_emergency": "",
    "contract_start": "",
    "contract_end": "",
    "contract_independent": false,
    "contract_type": "",
    "contract_type_localized": "",
    "classification": "",
    "employment_form": "",
    "employment_form_localized": "",
    "employment_status": "",
    "employment_status_localized": "",
    "personnel_nr": "",
    "dimona_nr": "",
    "drivers_license": false,
    "drivers_license_expire_date": "",
    "acknowledgement_nr_gv": "",
    "acknowledgement_nr_tv": "",
    "acknowledgement_nr_va": "",
    "acknowledgement_nr_sv": "",
    "acknowledgement_g1": false,
    "acknowledgement_g2": false,
    "acknowledgement_l": false,
    "distance_commute": 0,
    "active": true,
    "ts_lastupdate": "2025–02–12 14:26:33"
  }
]
}

/Employees/{id}/Upload

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/Upload

with the following parameters :

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

Body Parameters :
ParameterName: fileParameterValue: tptype.txt

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "name": "tptype.txt",
    "path_display": ".",
    "path_lower": ".",
    "id": "",
    "client_modified": "2025–02–12T14:26:35Z",
    "server_modified": "2025–02–12T14:26:35Z",
    "rev": "",
    "size": 425,
    "is_downloadable": true,
    "checksum": "ybDAv8jWoCaCG2VEQ9xEjcxbLVUYiaj1tprcFp2IWXU="
  }
]
}