| VismaBouwsoftAPICalls.v1_PUT_Addresses | Method |
This API call is used to update fields of a(n) Address
General Description
| HTTP method | API version |
|---|---|
| PUT | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Addresses/{id}
or
API Path: /Addresses/{id}/AddGroup
or
API Path: /Addresses/{id}/Anonimize
or
API Path: /Addresses/{id}/MakeCustomer
or
API Path: /Addresses/{id}/MakeSupplier
or
API Path: /Addresses/{id}/RemoveGroup
or
API Path: /Addresses/{id}/note_plain
You make this API call with the key field id as the path parameter (the id of the Address you want to update)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| city | String |
| ts_lastupdate | String |
| name | String |
| address | String |
| telephone1 | String |
| telephone2 | String |
| fax | String |
| gsm | String |
| String | |
| vatnr | String |
| iban1 | String |
| bic1 | String |
| iban2 | String |
| bic2 | String |
| groups | String |
| suppliernr | Number |
| clientnr | Number |
/Addresses/{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/Addresses/328891
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UbOfWxfrDkzSfIIIrfzRqDlIfDlrGfjVflbbzbPtflmfAGAPkA
Query Parameters :
ParameterName: columns, ParameterValue: city=’Houtave’
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 328891,
"city": "Houtave",
"ts_lastupdate": "2025–02–12 14:25:50"
}
]
}
/Addresses/{id}/AddGroup
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/Addresses/328891/AddGroup
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: IVmfWxfGOUzSfrkkbfzRqbkAfUfjGfGDfVlbzjGfkPbfAjIOUl
Query Parameters :
ParameterName: groupid, ParameterValue: 107
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 328891,
"groups": "testgroepAPI"
}
]
}
/Addresses/{id}/Anonimize
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/Addresses/328892/Anonimize
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UbOfWxfrDkzSfIIIrfzRqDlIfDlrGfjVflbbzbPtflmfAGAPkA
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 328892,
"name": "D",
"address": "M.",
"telephone1": "",
"telephone2": "",
"fax": "",
"gsm": "",
"email": "",
"vatnr": "",
"iban1": "",
"bic1": "",
"iban2": "",
"bic2": ""
}
]
}
/Addresses/{id}/MakeCustomer
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/Addresses/328891/MakeCustomer
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jfOfWxfrDrzSfVPItfzRqjOffIkbGfVUflbbzbVtVPkfrUODUf
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 328891,
"clientnr": 201700448,
"groups": ""
}
]
}
/Addresses/{id}/MakeSupplier
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/Addresses/328892/MakeSupplier
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jfOfWxfrDrzSfVPItfzRqjOffIkbGfVUflbbzbVtVPkfrUODUf
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 328892,
"suppliernr": 201700451,
"groups": ""
}
]
}
/Addresses/{id}/RemoveGroup
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/Addresses/328891/RemoveGroup
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: IVmfWxfGOUzSfrkkbfzRqbkAfUfjGfGDfVlbzjGfkPbfAjIOUl
Query Parameters :
ParameterName: groupid, ParameterValue: 107
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 328891,
"groups": ""
}
]
}
/Addresses/{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/Addresses/328892/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: PPPfWxfOmrzSfUDrDfzRqUGUfGVjkGVOfUAkzDtbVPbIDtbkDr
Body Parameters :
test
Success gives statuscode 200 And the following result
test