General Description

HTTP method	API version
PUT	v1

Don’t forget to put the Authorization field in the header

API Path: /Earthworks/{id}

You make this API call with the key field id as the path parameter (the id of the Earthwork you want to update)

Fields

The following fields are available:

Field Name	Type Id	Type Name	Length	Required	Writeable	Force Write
title	2	tpString	50	No	Yes	No
documentnr	1	tpLong	0	No	Yes	No
company_id	1	tpLong	0	No	Yes	No
date	3	tpDate	0	No	Yes	No
employee_id	1	tpLong	0	No	Yes	No
driver	2	tpString	150	No	No	No
machines_id	1	tpLong	0	No	Yes	No
machine	2	tpString	50	No	No	No
technicalreportnr	2	tpString	100	No	Yes	No
groundtransportnotificationnr	2	tpString	25	No	No	No
address_id	1	tpLong	0	No	No	No
name	2	tpString	150	No	No	No
address	2	tpString	63	No	No	No
countrycode	2	tpString	2	No	No	No
zipcode	2	tpString	15	No	No	No
city	2	tpString	40	No	No	No
contact_id	1	tpLong	0	No	No	No
contact_name	2	tpString	50	No	No	No
originproject_id	1	tpLong	0	No	Yes	No
originproject_name	2	tpString	100	No	No	No
originproject_pnr	1	tpLong	0	No	No	No
originproject_unr	1	tpLong	0	No	No	No
originproject_yourreference	2	tpString	50	No	No	No
originaddress	2	tpString	63	No	No	No
origincountrycode	2	tpString	2	No	No	No
originzipcode	2	tpString	15	No	No	No
origincity	2	tpString	40	No	No	No
originstate	2	tpString	40	No	No	No
destinationproject_id	1	tpLong	0	No	Yes	No
destinationproject_name	2	tpString	100	No	No	No
destinationproject_pnr	1	tpLong	0	No	No	No
destinationproject_unr	1	tpLong	0	No	No	No
destinationproject_yourreference	2	tpString	50	No	No	No
destinationaddress	2	tpString	63	No	No	No
destinationcountrycode	2	tpString	2	No	No	No
destinationzipcode	2	tpString	15	No	No	No
destinationcity	2	tpString	40	No	No	No
destinationstate	2	tpString	40	No	No	No

/Earthworks/{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/Earthworks/110

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: PrDfWxfDkfzSfOjtAfzRqtrmfOmVfGrmfDbkzrUVOjUGtrtDII

Query Parameters :
ParameterName: columns, ParameterValue: employee_id=6

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 110,
    "employee_id": 6,
    "driver": "John Cleerwerck"
  }
]
}