| VismaBouwsoftAPICalls.v1_GET_Planning | Method |
This API call is used to get fields of a(n) Planning(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Planning/
or
API Path: /Planning/{id}
You can make this API call:
* without the key field id to get a list of Planning
* with the key field id as the path parameter (the specific id of the Planning you want to get)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| name | String |
| all_day | Boolean |
| start | String |
| end | String |
| time_break | Number |
| total_days | Number |
| company_id | Number |
| company_name | String |
| project_id | Number |
| project_pnr | Number |
| project_unr | Number |
| project_name | String |
| workorder_id | Number |
| workorder_nr | Number |
| workorder_title | String |
| workorder_status | String |
| workorder_finished | Boolean |
| address_id | Number |
| address_name | String |
| address_address | String |
| address_addressline2 | String |
| address_countrycode | String |
| address_zipcode | String |
| address_city | String |
| employee_id | Number |
| employee_nr | Number |
| employee_name | String |
| crew_id | Number |
| crew_nr | String |
| crew_description | String |
/Planning/
API Path: /Planning/
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/Planning
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jIlfWxfAVAzSfOUObfzRqIVDfAkOfGUIfIkkzObAAtfGGGrtjA
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: -start
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/204”,
“Records”:
[
{
"id": 279,
"name": "",
"all_day": false,
"start": "2025–06–02 08:00:00",
"end": "2025–06–20 18:00:00",
"time_break": 2,
"total_days": 15,
"company_id": 1,
"company_name": "Bouwsoft",
"project_id": 2644,
"project_pnr": 20220046,
"project_unr": 2018001407,
"project_name": "Biran Blankenberge",
"workorder_id": 0,
"workorder_nr": 0,
"workorder_title": "",
"workorder_status": "To schedule",
"workorder_finished": false,
"address_id": 327927,
"address_name": "Biran",
"address_address": "Jaueslaan BB",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8370",
"address_city": "Blankenberge",
"employee_id": 72,
"employee_nr": 55,
"employee_name": "Decramer AndyVERT2",
"crew_id": 0,
"crew_nr": "",
"crew_description": ""
},
{
"id": 346,
"name": "",
"all_day": true,
"start": "2025–04–16",
"end": "2025–04–16 00:30:00",
"time_break": 0,
"total_days": 1,
"company_id": 0,
"company_name": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"workorder_id": 0,
"workorder_nr": 0,
"workorder_title": "",
"workorder_status": "To schedule",
"workorder_finished": false,
"address_id": 0,
"address_name": "",
"address_address": "",
"address_addressline2": "",
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"employee_id": 413,
"employee_nr": 2018119,
"employee_name": "Andy Bruggeman",
"crew_id": 0,
"crew_nr": "",
"crew_description": ""
}
,
…
]
}
https://ra.bouwsoft.be/api/v1/Planning
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jIlfWxfAVAzSfOUObfzRqIVDfAkOfGUIfIkkzObAAtfGGGrtjA
Query Parameters :
ParameterName: filter, ParameterValue: start gt ‘2025–03–24’ and start lt ‘2025–03–27’
ParameterName: sort, ParameterValue: start
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–6/7”,
“Records”:
[
{
"id": 339,
"name": "",
"all_day": false,
"start": "2025–03–24 08:00:00",
"end": "2025–03–25 18:00:00",
"time_break": 2,
"total_days": 1,
"company_id": 1,
"company_name": "Bouwsoft",
"project_id": 3153,
"project_pnr": 20250006,
"project_unr": 10007,
"project_name": "De Prest Brian Blankenberge",
"workorder_id": 0,
"workorder_nr": 0,
"workorder_title": "",
"workorder_status": "To schedule",
"workorder_finished": false,
"address_id": 167112,
"address_name": "De Prest Brian",
"address_address": "Jean Jaureslaan 8",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8370",
"address_city": "Blankenberge",
"employee_id": 0,
"employee_nr": 0,
"employee_name": "",
"crew_id": 4,
"crew_nr": "EQPE 01",
"crew_description": "Equipe peinture 01"
},
{
"id": 340,
"name": "",
"all_day": false,
"start": "2025–03–24 08:00:00",
"end": "2025–03–25 18:00:00",
"time_break": 2,
"total_days": 1,
"company_id": 1,
"company_name": "Bouwsoft",
"project_id": 3153,
"project_pnr": 20250006,
"project_unr": 10007,
"project_name": "De Prest Brian Blankenberge",
"workorder_id": 0,
"workorder_nr": 0,
"workorder_title": "",
"workorder_status": "To schedule",
"workorder_finished": false,
"address_id": 167112,
"address_name": "De Prest Brian",
"address_address": "Jean Jaureslaan 8",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8370",
"address_city": "Blankenberge",
"employee_id": 4,
"employee_nr": 122,
"employee_name": "Vandenbussche Bert 4",
"crew_id": 0,
"crew_nr": "",
"crew_description": ""
}
,
…
]
}
https://ra.bouwsoft.be/api/v1/Planning
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jIlfWxfAVAzSfOUObfzRqIVDfAkOfGUIfIkkzObAAtfGGGrtjA
Query Parameters :
ParameterName: columns, ParameterValue:
ParameterName: filter, ParameterValue: start gt ‘2025–03–24’ and start lt ‘2025–03–27’ and crew_id eq 4
ParameterName: sort, ParameterValue: start
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 339,
"name": "",
"all_day": false,
"start": "2025–03–24 08:00:00",
"end": "2025–03–25 18:00:00",
"time_break": 2,
"total_days": 1,
"company_id": 1,
"company_name": "Bouwsoft",
"project_id": 3153,
"project_pnr": 20250006,
"project_unr": 10007,
"project_name": "De Prest Brian Blankenberge",
"workorder_id": 0,
"workorder_nr": 0,
"workorder_title": "",
"workorder_status": "To schedule",
"workorder_finished": false,
"address_id": 167112,
"address_name": "De Prest Brian",
"address_address": "Jean Jaureslaan 8",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8370",
"address_city": "Blankenberge",
"employee_id": 0,
"employee_nr": 0,
"employee_name": "",
"crew_id": 4,
"crew_nr": "EQPE 01",
"crew_description": "Equipe peinture 01"
}
]
}
https://ra.bouwsoft.be/api/v1/Planning
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jIlfWxfAVAzSfOUObfzRqIVDfAkOfGUIfIkkzObAAtfGGGrtjA
Query Parameters :
ParameterName: filter, ParameterValue: start gt ‘2025–03–24’ and start lt ‘2025–03–27’ and employee_id eq 308
ParameterName: sort, ParameterValue: start
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–1/2”,
“Records”:
[
{
"id": 321,
"name": "",
"all_day": false,
"start": "2025–03–25 07:00:00",
"end": "2025–03–25 09:00:00",
"time_break": 0,
"total_days": 1,
"company_id": 10,
"company_name": "KVM&CO",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"workorder_id": 888,
"workorder_nr": 20210201,
"workorder_title": "",
"workorder_status": "In progress",
"workorder_finished": false,
"address_id": 0,
"address_name": "",
"address_address": "",
"address_addressline2": "",
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"employee_id": 308,
"employee_nr": 2018013,
"employee_name": "De Prest Brian",
"crew_id": 0,
"crew_nr": "",
"crew_description": ""
},
{
"id": 320,
"name": "",
"all_day": false,
"start": "2025–03–26 12:00:00",
"end": "2025–03–28 18:00:00",
"time_break": 0,
"total_days": 2,
"company_id": 2,
"company_name": "Groensoft",
"project_id": 3085,
"project_pnr": 2013068,
"project_unr": 1310,
"project_name": "Brian test NL Blankenberge",
"workorder_id": 0,
"workorder_nr": 0,
"workorder_title": "",
"workorder_status": "To schedule",
"workorder_finished": false,
"address_id": 277692,
"address_name": "Brian test NL",
"address_address": "Jean jaureslaan 8",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8370",
"address_city": "Blankenberge",
"employee_id": 308,
"employee_nr": 2018013,
"employee_name": "De Prest Brian",
"crew_id": 0,
"crew_nr": "",
"crew_description": ""
}
]
}
/Planning/{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/Planning/321
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jIlfWxfAVAzSfOUObfzRqIVDfAkOfGUIfIkkzObAAtfGGGrtjA
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 321,
"name": "",
"all_day": false,
"start": "2025–03–25 07:00:00",
"end": "2025–03–25 09:00:00",
"time_break": 0,
"total_days": 1,
"company_id": 10,
"company_name": "KVM&CO",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"workorder_id": 888,
"workorder_nr": 20210201,
"workorder_title": "",
"workorder_status": "In progress",
"workorder_finished": false,
"address_id": 0,
"address_name": "",
"address_address": "",
"address_addressline2": "",
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"employee_id": 308,
"employee_nr": 2018013,
"employee_name": "De Prest Brian",
"crew_id": 0,
"crew_nr": "",
"crew_description": ""
}
]
}