VismaBouwsoftAPICalls.v1_POST_Machines | Method |
This API call is used to add a(n) Machine
General Description
HTTP method | API version |
---|---|
POST | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Machines
or
API Path: /Machines/{id}/Upload
Fields
The following fields are available:
Field Name | Type |
---|---|
name | String |
path_display | String |
path_lower | String |
id | String |
client_modified | String |
server_modified | String |
rev | String |
size | Number |
is_downloadable | Boolean |
checksum | String |
list | String |
group | String |
nr | String |
description | String |
type | String |
brand | String |
chassisnr | String |
license_plate | String |
purchasedate | String |
constructionyear | Number |
company_id | Number |
company_name | String |
price_cost | Number |
price_catalogue | Number |
price_sales1 | Number |
price_sales2 | Number |
price_sales3 | Number |
margin_catalogue | Number |
margin1 | Number |
margin2 | Number |
margin3 | Number |
discount1 | Number |
discount2 | Number |
discount3 | Number |
supplier_id | Number |
supplier_name | String |
tech_checkup_last_date | String |
tech_checkup_expire_date | String |
unit | String |
geodyn_name | String |
ts_lastupdate | String |
/Machines
API Path: /Machines/
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/Machines
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bGkfWxfOkkzSfjfGjfzRqDrPffArfGrjfDVkzlDOGOmGbIIUfb
Query Parameters :
ParameterName: columns, ParameterValue: description=’machine added from api’
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 1995,
"list": "ALGEMEEN",
"group": "",
"nr": "Machine 4844212",
"description": "machine added from api",
"type": "",
"brand": "",
"chassisnr": "",
"license_plate": "",
"purchasedate": "",
"constructionyear": 0,
"company_id": 1,
"company_name": "Bouwsoft",
"price_cost": 0.0,
"price_catalogue": 0.0,
"price_sales1": 0.0,
"price_sales2": 0.0,
"price_sales3": 0.0,
"margin_catalogue": 21.9512,
"margin1": 0.0,
"margin2": 0.0,
"margin3": 0.0,
"discount1": 0.0,
"discount2": 0.0,
"discount3": 0.0,
"supplier_id": 0,
"supplier_name": "",
"tech_checkup_last_date": "",
"tech_checkup_expire_date": "",
"unit": "u.",
"geodyn_name": "",
"ts_lastupdate": "2025–02–12 14:26:59"
}
]
}
/Machines/{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/Machines/1995/Upload
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UUPfWxflbOzSfDUmUfzRqPjIftmbfGDbfkDkztAOGPkGmbVDbO
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:27:01Z",
"server_modified": "2025–02–12T14:27:01Z",
"rev": "",
"size": 425,
"is_downloadable": true,
"checksum": "wU7vqn627l3AjbBMva2zV+XS3W/RiQm8KjQfVwhoU2U="
}
]
}