General Description

HTTP method	API version
PUT	v1

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

API Path: /Assignments/{id}

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

Fields

The following fields are available:

Field Name	Type Id	Type Name	Length	Required	Writeable	Force Write
maintenancesheet_id	1	tpLong	0	No	Yes	No
company_id	1	tpLong	0	No	Yes	No
company_name	2	tpString	250	No	No	No
date	3	tpDate	0	No	Yes	No
dateplanned	6	tpDateNullString	0	No	No	No
nr	1	tpLong	0	No	Yes	No
title	2	tpString	100	No	Yes	No
subject	2	tpString	100	No	Yes	No
status	2	tpString	0	No	No	No
planned	5	tpBool	0	No	No	No
executed	5	tpBool	0	No	No	No
executed_on	2	tpString	0	No	No	No
checked	5	tpBool	0	No	No	No
invoiced	5	tpBool	0	No	No	No
finished	5	tpBool	0	No	No	No
sent	5	tpBool	0	No	No	No
sent_on	2	tpString	0	No	No	No
reschedule	5	tpBool	0	No	No	No
readonly	5	tpBool	0	No	No	No
employee_id	1	tpLong	0	No	Yes	No
employee_name	2	tpString	150	No	No	No
machine_id	1	tpLong	0	No	Yes	No
machine_nr	2	tpString	50	No	No	No
machine_description	2	tpString	100	No	No	No
execute	5	tpBool	0	No	Yes	No
description_customer	2	tpString	0	No	Yes	No
note_technician	2	tpString	0	No	Yes	No
address_id	1	tpLong	0	No	Yes	No
address_name	2	tpString	150	No	No	No
address_address	2	tpString	63	No	No	No
address_addressline2	2	tpString	63	No	No	No
address_countrycode	2	tpString	2	No	No	No
address_zipcode	2	tpString	15	No	No	No
address_city	2	tpString	40	No	No	No
addresscontact_id	1	tpLong	0	No	Yes	No
contact_salutation	2	tpString	50	No	No	No
contact_name	2	tpString	100	No	No	No
project_id	1	tpLong	0	No	Yes	No
project_pnr	1	tpLong	0	No	No	No
project_unr	1	tpLong	0	No	No	No
project_name	2	tpString	100	No	No	No
yourreference	2	tpString	50	No	No	No
ts_lastupdate	3	tpDate	0	No	No	No
actualcost_id	1	tpLong	0	No	No	No
actualcost_nr	1	tpLong	0	No	No	No
actualcost_datestart	3	tpDate	0	No	No	No
actualcostitem_id	1	tpLong	0	No	Yes	No
actualcostitem_description	2	tpString	0	No	No	No
actualcostitem_description_localized	2	tpString	0	No	No	No

/Assignments/{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/Assignments/1496

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: machine_id=2085

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 1496,
    "machine_id": 2085,
    "machine_nr": "Machine 4844302",
    "machine_description": "Diverse Graafmachine 3 old"
  }
]
}