| VismaBouwsoftAPICalls.v1_GET_Projects | Method |
This API call is used to get fields of a(n) Project(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Projects/
or
API Path: /Projects/{id}
or
API Path: /Projects/{id}/image
or
API Path: /Projects/{id}/note_html
or
API Path: /Projects/{id}/note_plain
or
API Path: /Projects/{id}/note_rtf
or
API Path: /Projects/FieldInfo/
You can make this API call:
* without the key field id to get a list of Projects
* with the key field id as the path parameter (the specific id of the Project you want to get)
* to request the FieldInfo for this call
Fields
The following fields are available:
| Field Name | Type Name | Length | Required | Writeable | Force Write | Link |
|---|---|---|---|---|---|---|
| pnr | tpLong | 0 | No | Yes | No | |
| unr | tpLong | 0 | No | Yes | No | |
| name | tpString | 100 | No | Yes | No | |
| yourreference | tpString | 50 | No | Yes | No | |
| list | tpString | 50 | No | No | No | |
| group | tpString | 50 | No | No | No | |
| address | tpString | 63 | No | Yes | No | |
| addressline2 | tpString | 63 | No | Yes | No | |
| telephone1 | tpString | 25 | No | Yes | No | |
| gsm | tpString | 25 | No | Yes | No | |
| countrycode | tpString | 2 | No | Yes | No | |
| zipcode | tpString | 15 | No | Yes | No | |
| city | tpString | 40 | No | Yes | No | |
| state | tpString | 40 | No | Yes | No | |
| distance | tpDouble | 0 | No | Yes | No | |
| client_addressid | tpLong | 0 | Yes | Yes | No | Addresses |
| client_name | tpString | 150 | No | No | No | |
| client_telephone | tpString | 25 | No | No | No | |
| client_gsm | tpString | 25 | No | No | No | |
| client_email | tpString | 100 | No | No | No | |
| client_readonly | tpBool | 0 | No | No | No | |
| date_created | tpDate | 0 | No | No | No | |
| date_approved | tpDateNullString | 0 | No | No | No | |
| date_rejected | tpDateNullString | 0 | No | No | No | |
| date_completed | tpDateNullString | 0 | No | No | No | |
| ordernr | tpString | 100 | No | Yes | No | |
| contractamount | tpCurrency | 0 | No | No | No | |
| iscostplusproject | tpBool | 0 | No | Yes | No | |
| isrealestateproject | tpBool | 0 | No | Yes | No | |
| hasactualcosts | tpBool | 0 | No | No | No | |
| archivenr | tpString | 50 | No | Yes | No | |
| cadaster_department | tpString | 50 | No | No | No | |
| cadaster_section | tpString | 50 | No | Yes | No | |
| cadaster_nr | tpString | 250 | No | Yes | No | |
| be_gewestplan | tpString | 50 | No | Yes | No | |
| be_werkplaatsnr30bis | tpString | 50 | No | Yes | No | |
| be_bpa | tpString | 50 | No | Yes | No | |
| be_rup | tpString | 50 | No | Yes | No | |
| lotnr | tpString | 50 | No | Yes | No | |
| company_id | tpLong | 0 | Yes | Yes | No | CompanyDetails |
| company_name | tpString | 250 | No | No | No | |
| executiontime | tpLong | 0 | No | Yes | No | |
| approved | tpBool | 0 | No | No | No | |
| rejected | tpBool | 0 | No | Yes | No | |
| completed | tpBool | 0 | No | Yes | No | |
| parent_id | tpLong | 0 | No | No | No | Projects |
| currentphase_id | tpLong | 0 | No | No | No | |
| currentphase_title | tpString | 50 | No | No | No | |
| active | tpBool | 0 | No | No | No | |
| ts_lastupdate | tpDate | 0 | No | No | No |
/Projects/
API Path: /Projects/
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/Projects
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VGUfWxfUAbzSfUGGAfzRqbbrftmUfGUrfGtkzrDfGbDGfPjUIU
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/2590”,
“Records”:
[
{
"id": 3,
"pnr": 20120003,
"unr": 3,
"name": "Project Parketvloeren 2016",
"yourreference": "",
"list": "ALGEMEEN",
"group": "klein",
"address": "Zeedijkweg 23a",
"addressline2": "",
"telephone1": "+32 50 82 21 67 ",
"gsm": "",
"countrycode": "BE",
"zipcode": "8890",
"city": "Dadizele",
"state": "West-Vlaanderen",
"distance": 57.954000000000001,
"client_addressid": 24,
"client_name": "Bouwsoft Adventures",
"client_telephone": "+32 50 45 40 87 ",
"client_gsm": "",
"client_email": "bert@bouwsoft.be",
"client_readonly": false,
"date_created": "2012–03–07",
"date_approved": "2012–03–07",
"date_rejected": "",
"date_completed": "",
"ordernr": "",
"contractamount": 13463.319999999999709,
"iscostplusproject": false,
"isrealestateproject": true,
"hasactualcosts": true,
"archivenr": "",
"cadaster_department": "",
"cadaster_section": "",
"cadaster_nr": "",
"be_gewestplan": "",
"be_werkplaatsnr30bis": "",
"be_bpa": "",
"be_rup": "",
"lotnr": "",
"company_id": 1,
"company_name": "Bouwsoft",
"executiontime": 20,
"approved": true,
"rejected": false,
"completed": false,
"parent_id": 424,
"currentphase_id": 54,
"currentphase_title": "02. Starting Date Of The Work",
"active": true,
"ts_lastupdate": "2022–08–29 14:41:52"
},
{
"id": 5,
"pnr": 20180154,
"unr": 4,
"name": "Projekt Foto Dekoration",
"yourreference": "Pestana UK 76993–215",
"list": "PRIVE",
"group": "Art & Decoration",
"address": "a",
"addressline2": "",
"telephone1": "+44 20 70 62 80 00 ",
"gsm": "",
"countrycode": "UK",
"zipcode": "SW8 4AE",
"city": "London",
"state": "",
"distance": 0,
"client_addressid": 39377,
"client_name": "Kjell Vanwalleghem",
"client_telephone": "+32 50 20 21 55 ",
"client_gsm": "+32 477 56 44 88",
"client_email": "",
"client_readonly": false,
"date_created": "2018–06–05",
"date_approved": "2012–03–20",
"date_rejected": "",
"date_completed": "",
"ordernr": "",
"contractamount": 34805.739999999997963,
"iscostplusproject": false,
"isrealestateproject": true,
"hasactualcosts": true,
"archivenr": "",
"cadaster_department": "",
"cadaster_section": "",
"cadaster_nr": "",
"be_gewestplan": "",
"be_werkplaatsnr30bis": "aaaaaaaaaaaa",
"be_bpa": "",
"be_rup": "",
"lotnr": "",
"company_id": 10,
"company_name": "KVM&CO",
"executiontime": 5,
"approved": true,
"rejected": false,
"completed": false,
"parent_id": 0,
"currentphase_id": 54,
"currentphase_title": "02. Starting Date Of The Work",
"active": true,
"ts_lastupdate": "2022–07–28 12:23:19"
}
,
…
]
}
/Projects/{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/Projects/3319
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: DVGfWxfOmAzSfbfrUfzRqOjPfrUIfGVAfkOkzjDlflrGlGAljP
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 3319,
"pnr": 2021060078,
"unr": 1275,
"name": "Schilderen van API blokjes",
"yourreference": "",
"list": "",
"group": "",
"address": "Gruuthof 23",
"addressline2": "",
"telephone1": "",
"gsm": "",
"countrycode": "BE",
"zipcode": "8490",
"city": "Varsenare",
"state": "West-vlaanderen",
"distance": 20,
"client_addressid": 3759,
"client_name": "Spikesoft",
"client_telephone": "+32 486 60 64 21 ",
"client_gsm": "",
"client_email": "gino@bouwsoft.be",
"client_readonly": false,
"date_created": "2026–03–24",
"date_approved": "2026–03–24",
"date_rejected": "",
"date_completed": "",
"ordernr": "",
"contractamount": 0.0,
"iscostplusproject": false,
"isrealestateproject": true,
"hasactualcosts": true,
"archivenr": "",
"cadaster_department": "",
"cadaster_section": "",
"cadaster_nr": "",
"be_gewestplan": "",
"be_werkplaatsnr30bis": "",
"be_bpa": "",
"be_rup": "",
"lotnr": "",
"company_id": 2,
"company_name": "Groensoft",
"executiontime": 0,
"approved": true,
"rejected": false,
"completed": false,
"parent_id": 0,
"currentphase_id": 1045,
"currentphase_title": "12. 1 ste schijf",
"active": true,
"ts_lastupdate": "2026–03–24 14:27:24"
}
]
}
/Projects/{id}/image
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/Projects/2330/image
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: rVAfWxflGjzSfltGffzRqOmVfOArGfUtfbIbztkrmDDfGPkArD
Success gives statuscode 200 And the following result
image
/Projects/{id}/note_html
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/Projects/2330/note_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: rVAfWxflGjzSfltGffzRqOmVfOArGfUtfbIbztkrmDDfGPkArD
Success gives statuscode 200 And the following result
<HTML><BODY>
<DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Montserrat;font-size: 11pt;color: #000000;">TestNota voor de API unittests <B>(niet aanpassen aub)</SPAN></DIV></B>
</BODY></HTML>
/Projects/{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/Projects/2330/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: rVAfWxflGjzSfltGffzRqOmVfOArGfUtfbIbztkrmDDfGPkArD
Success gives statuscode 200 And the following result
TestNota voor de API unittests (niet aanpassen aub)
/Projects/{id}/note_rtf
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/Projects/2330/note_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Montserrat;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs22\cf1 TestNota voor de API unittests \b (niet aanpassen aub)}
/Projects/FieldInfo
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/Projects/FieldInfo
with the following parameters :
Header Parameters :
ParameterName: AccessToken, ParameterValue: UOIfWxffkAzSfrUjPtzRqUUbfkrkIOlljbPtzDDlVrfGjAmtfb
ParameterName: Clientnr, ParameterValue: 115
Success gives statuscode 200 And the following result
[
{
"name": "pnr",
"type_id": 1,
"type_name": "tpLong",
"length": 0,
"required": false,
"writeable": true,
"forcewrite": false,
"link": ""
},
{
"name": "unr",
"type_id": 1,
"type_name": "tpLong",
"length": 0,
"required": false,
"writeable": true,
"forcewrite": false,
"link": ""
}
,
…
]