VismaBouwsoftAPICalls.v1_POST_Earthworks | Method |
This API call is used to add a(n) Earthwork
General Description
HTTP method | API version |
---|---|
POST | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Earthworks
or
Fields
The following fields are available:
Field Name | Type |
---|---|
id | Number |
title | String |
documentnr | Number |
company_id | Number |
date | String |
employee_id | Number |
driver | String |
machines_id | Number |
machine | String |
technicalreportnr | String |
groundtransportnotificationnr | String |
address_id | Number |
name | String |
address | String |
countrycode | String |
zipcode | String |
city | String |
contact_id | Number |
contact_name | String |
originproject_id | Number |
originproject_name | String |
originproject_pnr | Number |
originproject_unr | Number |
originproject_yourreference | String |
originaddress | String |
origincountrycode | String |
originzipcode | String |
origincity | String |
originstate | String |
destinationproject_id | Number |
destinationproject_name | String |
destinationproject_pnr | Number |
destinationproject_unr | Number |
destinationproject_yourreference | String |
destinationaddress | String |
destinationcountrycode | String |
destinationzipcode | String |
destinationcity | String |
destinationstate | String |
earthworks_id | Number |
product_id | Number |
product_nr | String |
product_description | String |
linenr | Number |
quantity | Number |
unit | String |
unit_localized | String |
/Earthworks
API Path: /Earthworks/
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/Earthworks
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: blOfWxfVrtzSfGkIjfzRqmUtfDIlfGbIfUOkzIrAbfAGflIjlt
Query Parameters :
ParameterName: columns, ParameterValue: company_id=2,employee_id=301
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 105,
"title": "",
"documentnr": 147,
"company_id": 2,
"date": "2025–02–12",
"employee_id": 301,
"driver": "Andy Averechtss",
"machines_id": 0,
"machine": "",
"technicalreportnr": "",
"groundtransportnotificationnr": "",
"address_id": 0,
"name": "",
"address": "",
"countrycode": "",
"zipcode": "",
"city": "",
"contact_id": 0,
"contact_name": "",
"originproject_id": 0,
"originproject_name": "",
"originproject_pnr": 0,
"originproject_unr": 0,
"originproject_yourreference": "",
"originaddress": "",
"origincountrycode": "",
"originzipcode": "",
"origincity": "",
"originstate": "",
"destinationproject_id": 0,
"destinationproject_name": "",
"destinationproject_pnr": 0,
"destinationproject_unr": 0,
"destinationproject_yourreference": "",
"destinationaddress": "",
"destinationcountrycode": "",
"destinationzipcode": "",
"destinationcity": "",
"destinationstate": ""
}
]
}