| VismaBouwsoftAPICalls.v1_GET_LoanedMachines | Method |
This API call is used to get fields of a(n) LoanedMachine(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /LoanedMachines/
or
API Path: /LoanedMachines/{id}
or
API Path: /LoanedMachines/{id}/image
or
API Path: /LoanedMachines/{id}/note_html
or
API Path: /LoanedMachines/{id}/note_plain
or
API Path: /LoanedMachines/{id}/note_rtf
You can make this API call:
* without the key field id to get a list of LoanedMachines
* with the key field id as the path parameter (the specific id of the LoanedMachine you want to get)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| date_from | String |
| date_to | String |
| days_loaned | Number |
| days_late | Number |
| returned | Boolean |
| machine_id | Number |
| machine_nr | String |
| machine_description | String |
| guarantee | Number |
| price_per_day | Number |
| invoice_id | Number |
| invoice_nr | Number |
| address_id | Number |
| address_salutation | String |
| address_name | String |
| address_address | String |
| address_addressline2 | String |
| address_latitude | Number |
| address_longitude | Number |
| address_countrycode | String |
| address_zipcode | String |
| address_city | String |
| address_state | String |
| address_telephone1 | String |
| address_telephone2 | String |
| address_fax | String |
| address_gsm | String |
| address_email | String |
| contact_id | Number |
| contact_salutation | String |
| contact_name | String |
| project_id | Number |
| project_pnr | Number |
| project_unr | Number |
| project_name | String |
| yourreference | String |
| be_werkplaatsnr30bis | String |
/LoanedMachines/
API Path: /LoanedMachines/
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 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/LoanedMachines
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: lkrfWxffOUzSfrrtIfzRqIrjfOflfGtPfUtkzjfDjDGGUVlmUU
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: nextid, ParameterValue:
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/148”,
“Records”:
[
{
"id": 1,
"date_from": "2012–05–22",
"date_to": "2012–05–25",
"days_loaned": 4,
"days_late": 0,
"returned": true,
"machine_id": 4,
"machine_nr": "1703 Minigraver",
"machine_description": "Wacker Neuson 1703 Minigraver",
"guarantee": 0.0,
"price_per_day": 0.0,
"invoice_id": 0,
"invoice_nr": 0,
"address_id": 0,
"address_salutation": "",
"address_name": "",
"address_address": "",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"address_state": "",
"address_telephone1": "",
"address_telephone2": "",
"address_fax": "",
"address_gsm": "",
"address_email": "",
"contact_id": 0,
"contact_salutation": "",
"contact_name": "",
"project_id": 5,
"project_pnr": 20180154,
"project_unr": 4,
"project_name": "Project: Photo Decoration",
"yourreference": "Pestana UK 76993–215",
"be_werkplaatsnr30bis": ""
},
{
"id": 2,
"date_from": "2013–12–13",
"date_to": "",
"days_loaned": 0,
"days_late": 0,
"returned": true,
"machine_id": 6,
"machine_nr": "CA.01",
"machine_description": "Camion met open laadbak (GWB–057)",
"guarantee": 0.0,
"price_per_day": 0.0,
"invoice_id": 0,
"invoice_nr": 0,
"address_id": 1755,
"address_salutation": "",
"address_name": "PETER COX",
"address_address": "NEERLANDWEG 24B",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"address_countrycode": "BE",
"address_zipcode": "2610",
"address_city": "Wilrijk (Antwerpen)",
"address_state": "Antwerpen",
"address_telephone1": "+32 3 830 40 19 ",
"address_telephone2": "",
"address_fax": "",
"address_gsm": "+32 495 29 97 42 ",
"address_email": "",
"contact_id": 1755,
"contact_salutation": "",
"contact_name": "",
"project_id": 755,
"project_pnr": 20170001,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": ""
}
,
…
]
}
https://ra.bouwsoft.be/api/v1/LoanedMachines
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: PrDfWxfDkfzSfOjtAfzRqtrmfOmVfGrmfDbkzrUVOjUGtrtDII
Query Parameters :
ParameterName: filter, ParameterValue: days_loaned gt 2000
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–38/39”,
“Records”:
[
{
"id": 14,
"date_from": "2015–08–24",
"date_to": "2023–01–05",
"days_loaned": 2692,
"days_late": 0,
"returned": true,
"machine_id": 68,
"machine_nr": "01.03",
"machine_description": "Uurtarief kraan + operator K31/35 bijkomend uur",
"guarantee": 0.0,
"price_per_day": 80.0,
"invoice_id": 0,
"invoice_nr": 0,
"address_id": 0,
"address_salutation": "",
"address_name": "",
"address_address": "",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"address_state": "",
"address_telephone1": "",
"address_telephone2": "",
"address_fax": "",
"address_gsm": "",
"address_email": "",
"contact_id": 0,
"contact_salutation": "",
"contact_name": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": ""
},
{
"id": 19,
"date_from": "2016–02–01",
"date_to": "2023–01–05",
"days_loaned": 2531,
"days_late": 0,
"returned": true,
"machine_id": 80,
"machine_nr": "01.15",
"machine_description": "Veiligheidsnetten (forfait tot 1000m²)",
"guarantee": 0.0,
"price_per_day": 0.0,
"invoice_id": 0,
"invoice_nr": 0,
"address_id": 0,
"address_salutation": "",
"address_name": "Andy Averechts",
"address_address": "Hogeweg 37",
"address_addressline2": "",
"address_latitude": 51.204320000000003,
"address_longitude": 3.20211,
"address_countrycode": "BE",
"address_zipcode": "8200",
"address_city": "Brugge",
"address_state": "West-Vlaanderen",
"address_telephone1": "",
"address_telephone2": "",
"address_fax": "",
"address_gsm": "",
"address_email": "",
"contact_id": 0,
"contact_salutation": "",
"contact_name": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": ""
}
,
…
]
}
/LoanedMachines/{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/LoanedMachines/4
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: APVfWxfOGIzSfrDlDfzRqjGGfIPkfGDGfVfkzDPltGlGGtjDOk
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 4,
"date_from": "2014–12–01",
"date_to": "2019–06–24",
"days_loaned": 1667,
"days_late": 0,
"returned": true,
"machine_id": 66,
"machine_nr": "01.01",
"machine_description": "Dagprijs kraan + operator K31/35 ( forfait van 8u ter plaatse, incl. 1u verplaatsing)",
"guarantee": 0.0,
"price_per_day": 240.0,
"invoice_id": 0,
"invoice_nr": 0,
"address_id": 42391,
"address_salutation": "",
"address_name": "’T ZWALUWNEST VOF",
"address_address": "WESTKAPELSE STEENWEG 36",
"address_addressline2": "",
"address_latitude": 51.274790000000003,
"address_longitude": 3.22657,
"address_countrycode": "BE",
"address_zipcode": "8380",
"address_city": "BRUGGE",
"address_state": "West-Vlaanderen",
"address_telephone1": "",
"address_telephone2": "",
"address_fax": "",
"address_gsm": "",
"address_email": "",
"contact_id": 42391,
"contact_salutation": "",
"contact_name": "",
"project_id": 383,
"project_pnr": 20180160,
"project_unr": 208,
"project_name": "test fases archisoft 2",
"yourreference": "",
"be_werkplaatsnr30bis": ""
}
]
}
/LoanedMachines/{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/LoanedMachines/4/image
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bPffWxflUIzSfGlGmfzRqUtrfOmAGfGjfUDbzGUUADDfPmjtPP
Success gives statuscode 200 And the following result
image
/LoanedMachines/{id}/note_html
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/LoanedMachines/4/note_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: lmVfWxfPUkzSfjfkDfzRqUGIfDrVkGVPftIkzOPAODfIPDVDfI
Success gives statuscode 200 And the following result
<HTML><BODY>
<DIV STYLE="text-align: left;"></DIV>
</BODY></HTML>
/LoanedMachines/{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/LoanedMachines/4/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: lmVfWxfPUkzSfjfkDfzRqUGIfDrVkGVPftIkzOPAODfIPDVDfI
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
}
]
}
/LoanedMachines/{id}/note_rtf
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/LoanedMachines/4/note_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: lmVfWxfPUkzSfjfkDfzRqUGIfDrVkGVPftIkzOPAODfIPDVDfI
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Times New Roman;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0}