VismaBouwsoftAPICalls.v1_PUT_Projects | Method |
This API call is used to update fields of a(n) Project
General Description
HTTP method | API version |
---|---|
PUT | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Projects/{id}
or
API Path: /Projects/{id}/ApproveProject
or
API Path: /Projects/{id}/AssignList
or
API Path: /Projects/{id}/UnAssignList
You make this API call with the key field id as the path parameter (the id of the Project you want to update)
Fields
The following fields are available:
Field Name | Type |
---|---|
id | Number |
unr | Number |
date_approved | String |
approved | Boolean |
ts_lastupdate | String |
list | String |
group | String |
address | String |
zipcode | String |
city | String |
state | String |
countrycode | String |
distance | Number |
/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/3149
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UrkfWxfGVOzSfDAfbfzRqGkbfAkVGfjVfAmbzmOkjbffUfjjfb
Query Parameters :
ParameterName: columns, ParameterValue: unr=1275
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3149,
"unr": 1275
}
]
}
https://ra.bouwsoft.be/api/v1/Projects/3150
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: rOmfWxfAfGzSfOOlOfzRqmIjflVUGflAfDUbzmlfDVUfrGUIrO
Query Parameters :
ParameterName: columns, ParameterValue: address=’Gistelse steenweg 80‘,zipcode=’8200’,countrycode=’BE‘,city=’Brugge’
ParameterName: calculateDistance, ParameterValue: False
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3150,
"address": "Gistelse steenweg 80",
"zipcode": "8200",
"city": "Brugge",
"state": "West-Vlaanderen",
"ts_lastupdate": "2025–02–12 14:26:08"
}
]
}
https://ra.bouwsoft.be/api/v1/Projects/3149
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VrUfWxfArrzSfjjbtfzRqPtGfkbkGfVjfUkbzjfbfbVflfDjVP
Query Parameters :
ParameterName: columns, ParameterValue: client_addressid=3759,address=’Gruuthof 23‘,zipcode=’8490’,countrycode=’BE‘,city=’Varsenare’
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3149,
"address": "Gruuthof 23",
"zipcode": "8490",
"city": "Varsenare",
"state": "West-vlaanderen",
"ts_lastupdate": "2025–02–12 14:26:12"
}
]
}
https://ra.bouwsoft.be/api/v1/Projects/3149
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VGVfWxftUIzSfbrIAfzRqkrOftmPGfVPfIrbzPOjbUmfGmAbOA
Query Parameters :
ParameterName: columns, ParameterValue: address=’Gistelse steenweg 41‘,zipcode=’8200’,countrycode=’BE‘,city=’Brugge’,distance=20
ParameterName: calculateDistance, ParameterValue: false
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3149,
"address": "Gistelse steenweg 41",
"countrycode": "BE",
"zipcode": "8200",
"city": "Brugge",
"state": "West-Vlaanderen",
"distance": 20,
"ts_lastupdate": "2025–02–12 14:25:53"
}
]
}
https://ra.bouwsoft.be/api/v1/Projects/3150
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: kkGfWxffDOzSftmGkfzRqPGbfAmDkGGPfGtkzUDmOfOIOOVlIj
Query Parameters :
ParameterName: columns, ParameterValue: address=’Gistelse steenweg 80‘,zipcode=’8200’,countrycode=’BE‘,city=’Brugge’
ParameterName: calculateDistance, ParameterValue: True
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3150,
"address": "Gistelse steenweg 80",
"zipcode": "8200",
"city": "Brugge",
"state": "West-Vlaanderen",
"distance": 6.594,
"ts_lastupdate": "2025–02–12 14:26:01"
}
]
}
/Projects/{id}/ApproveProject
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/ApproveProject
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UbOfWxfrDkzSfIIIrfzRqDlIfDlrGfjVflbbzbPtflmfAGAPkA
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3149,
"unr": 1313,
"date_approved": "2025–02–12",
"approved": true,
"ts_lastupdate": "2025–02–12 00:00:00"
}
]
}
/Projects/{id}/AssignList
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/AssignList
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VVIfWxfjtPzSfVGOrfzRqlkmfjGGGfkUfUbbzfUflbtfDPfbbm
Query Parameters :
ParameterName: list, ParameterValue: APIProjectList
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3149,
"list": "APIPROJECTLIST",
"group": ""
}
]
}
/Projects/{id}/UnAssignList
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/UnAssignList
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: PVbfWxfmPPzSffmbIfzRqjmVftIGGfflftfbzmPbGUjfOIbkGr
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 3149,
"list": "",
"group": ""
}
]
}