VismaBouwsoftAPICalls.v1_PUT_OrderLines | Method |
This API call is used to update fields of a(n) OrderLine
General Description
HTTP method | API version |
---|---|
PUT | v1 |
Don’t forget to put the Authorization field in the header
API Path: /OrderLines/{id}
or
API Path: /OrderLines/{id}/Image
or
API Path: /OrderLines/{id}/note_plain
You make this API call with the key field id as the path parameter (the id of the OrderLine you want to update)
Fields
The following fields are available:
Field Name | Type |
---|---|
id | Number |
group | String |
description | String |
price_unit | Number |
price_unit_afterdiscount | Number |
cost_products | Number |
ts_lastupdate | String |
linkedto_type | String |
linkedto_type_localized | String |
linkedto_source | Number |
linkedto_id | Number |
nr1 | String |
unit1 | String |
unit1_localized | String |
/OrderLines/{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/OrderLines/139690
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: mlUfWxfPVmzSfPjjkfzRqVPlfGGtGftVfAGbzGtlfkUfmOmAVm
Query Parameters :
ParameterName: columns, ParameterValue: price_unit=0.85,group=’APITest‘,description=’API Description’
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 139690,
"group": "APITest",
"description": "API Description",
"price_unit": 0.85,
"price_unit_afterdiscount": 0.85,
"cost_products": 0.85,
"ts_lastupdate": "2025–02–12 14:30:36"
}
]
}
https://ra.bouwsoft.be/api/v1/OrderLines/139691
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VUUfWxfODrzSfDlUffzRqlGffDPPfGAPflOkzGmtlrUGVjIAOk
Query Parameters :
ParameterName: columns, ParameterValue: group=’TESTDIRK‘,nr1=’01.0001’
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 139691,
"linkedto_type": "product",
"linkedto_type_localized": "Article",
"linkedto_source": 11,
"linkedto_id": 2237653,
"group": "TESTDIRK",
"nr1": "01.0001",
"description": "MANITOU MAN’GO 12 Categorie: kniktelescopische-hoogwerkers MANITOU MAN’GO 12, Diesel - Dagprijs: € 165, vanaf 2tot4 dagen: € 130, weekprijs: € 490, maandprijs: € 400 /week Accessoires : Operator - CAT 1, Werftank (mazout) 1100 l Vlarem II met tankpistool, Nummerplaat,",
"unit1": "st.",
"unit1_localized": "pc.",
"ts_lastupdate": "2025–02–12 14:30:09"
}
]
}
/OrderLines/{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/OrderLines/139690/Image
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GllfWxfIVDzSfDDAPfzRqUAmfVfDGfUffDrbzIllbPUfDbArrm
Body Parameters :
ParameterName: fileParameterValue: bouwsoft.jpg
Success gives statuscode 201 And the following result
image
/OrderLines/{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/OrderLines/139690/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: PPPfWxfOmrzSfUDrDfzRqUGUfGVjkGVOfUAkzDtbVPbIDtbkDr
Body Parameters :
testnote via api
Success gives statuscode 200 And the following result
testnote via api