General Description

HTTP method	API version
POST	v1

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

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

Fields

The following fields are available:

Field Name	Type
id	Number
pnr	Number
unr	Number
name	String
yourreference	String
list	String
group	String
address	String
addressline2	String
telephone1	String
gsm	String
countrycode	String
zipcode	String
city	String
state	String
distance	Number
client_addressid	Number
client_name	String
client_telephone	String
client_gsm	String
client_email	String
client_readonly	Boolean
date_created	String
date_approved	String
date_rejected	String
date_completed	String
ordernr	String
contractamount	Number
iscostplusproject	Boolean
isrealestateproject	Boolean
hasactualcosts	Boolean
archivenr	String
cadaster_department	String
cadaster_section	String
cadaster_nr	String
be_gewestplan	String
be_werkplaatsnr30bis	String
be_bpa	String
be_rup	String
lotnr	String
company_id	Number
company_name	String
executiontime	Number
approved	Boolean
rejected	Boolean
completed	Boolean
parent_id	Number
currentphase_id	Number
currentphase_title	String
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

/Projects

API Path: /Projects/

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: company_id=2,name=’Schilderen van API blokjes’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 3149,
    "pnr": 2013086,
    "unr": 0,
    "name": "Schilderen van API blokjes",
    "yourreference": "",
    "list": "",
    "group": "",
    "address": "",
    "addressline2": "",
    "telephone1": "",
    "gsm": "",
    "countrycode": "",
    "zipcode": "",
    "city": "",
    "state": "",
    "distance": 0,
    "client_addressid": 0,
    "client_name": "",
    "client_telephone": "",
    "client_gsm": "",
    "client_email": "",
    "client_readonly": false,
    "date_created": "2025–02–12",
    "date_approved": "",
    "date_rejected": "",
    "date_completed": "",
    "ordernr": "",
    "contractamount": 0.0,
    "iscostplusproject": false,
    "isrealestateproject": true,
    "hasactualcosts": false,
    "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": false,
    "rejected": false,
    "completed": false,
    "parent_id": 0,
    "currentphase_id": 3,
    "currentphase_title": "05. Price Request",
    "active": true,
    "ts_lastupdate": "2025–02–12 14:25:52"
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,name=’Project via API‘,address=’Gruuthof 23’,zipcode=’8490‘,countrycode=’BE’,city=’Varsenare’
ParameterName: calculateDistance, ParameterValue: False

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 3150,
    "pnr": 20250003,
    "unr": 0,
    "name": "Project via API",
    "yourreference": "",
    "list": "",
    "group": "",
    "address": "Gruuthof 23",
    "addressline2": "",
    "telephone1": "",
    "gsm": "",
    "countrycode": "BE",
    "zipcode": "8490",
    "city": "Varsenare",
    "state": "West-vlaanderen",
    "distance": 0,
    "client_addressid": 0,
    "client_name": "",
    "client_telephone": "",
    "client_gsm": "",
    "client_email": "",
    "client_readonly": false,
    "date_created": "2025–02–12",
    "date_approved": "",
    "date_rejected": "",
    "date_completed": "",
    "ordernr": "",
    "contractamount": 0.0,
    "iscostplusproject": false,
    "isrealestateproject": true,
    "hasactualcosts": false,
    "archivenr": "",
    "cadaster_department": "",
    "cadaster_section": "",
    "cadaster_nr": "",
    "be_gewestplan": "",
    "be_werkplaatsnr30bis": "",
    "be_bpa": "",
    "be_rup": "",
    "lotnr": "",
    "company_id": 1,
    "company_name": "Bouwsoft",
    "executiontime": 0,
    "approved": false,
    "rejected": false,
    "completed": false,
    "parent_id": 0,
    "currentphase_id": 3,
    "currentphase_title": "05. Price Request",
    "active": true,
    "ts_lastupdate": "2025–02–12 14:26:07"
  }
]
}

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

with the following parameters :

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

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 3150,
    "pnr": 20250003,
    "unr": 0,
    "name": "Project via API",
    "yourreference": "",
    "list": "",
    "group": "",
    "address": "Gruuthof 23",
    "addressline2": "",
    "telephone1": "",
    "gsm": "",
    "countrycode": "BE",
    "zipcode": "8490",
    "city": "Varsenare",
    "state": "West-vlaanderen",
    "distance": 9.276,
    "client_addressid": 0,
    "client_name": "",
    "client_telephone": "",
    "client_gsm": "",
    "client_email": "",
    "client_readonly": false,
    "date_created": "2025–02–12",
    "date_approved": "",
    "date_rejected": "",
    "date_completed": "",
    "ordernr": "",
    "contractamount": 0.0,
    "iscostplusproject": false,
    "isrealestateproject": true,
    "hasactualcosts": false,
    "archivenr": "",
    "cadaster_department": "",
    "cadaster_section": "",
    "cadaster_nr": "",
    "be_gewestplan": "",
    "be_werkplaatsnr30bis": "",
    "be_bpa": "",
    "be_rup": "",
    "lotnr": "",
    "company_id": 1,
    "company_name": "Bouwsoft",
    "executiontime": 0,
    "approved": false,
    "rejected": false,
    "completed": false,
    "parent_id": 0,
    "currentphase_id": 3,
    "currentphase_title": "05. Price Request",
    "active": true,
    "ts_lastupdate": "2025–02–12 14:26:00"
  }
]
}

/Projects/{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/Projects/3149/Upload

with the following parameters :

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

Query Parameters :
ParameterName: folder, ParameterValue: testfolder

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:25:55Z",
    "server_modified": "2025–02–12T14:25:55Z",
    "rev": "",
    "size": 425,
    "is_downloadable": true,
    "checksum": "Hyhu+yp6kx8K5s94Y3UIXXcwNpHccZlJbo5C44epzHk="
  }
]
}