| VismaBouwsoftAPICalls.v1_GET_MaintenanceSheet | Method |
This API call is used to get fields of a(n) MaintenanceSheet(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /MaintenanceSheet/
or
API Path: /MaintenanceSheet/{id}
or
API Path: /MaintenanceSheet/{id}/note_plain
You can make this API call:
* without the key field id to get a list of MaintenanceSheet
* with the key field id as the path parameter (the specific id of the MaintenanceSheet you want to get)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| list | String |
| group | String |
| nr1 | String |
| nr2 | String |
| description | String |
| address_id | Number |
| address_name | String |
| address_address | String |
| address_addressline2 | String |
| address_countrycode | String |
| address_zipcode | String |
| address_city | String |
| address_telephone | String |
| address_gsm | String |
| address_email | String |
| project_id | Number |
| project_name | String |
| project_pnr | Number |
| project_unr | Number |
| project_yourreference | String |
| project_address | String |
| project_addressline2 | String |
| project_countrycode | String |
| project_zipcode | String |
| project_city | String |
| installationdate | String |
| installation_invoiceid | Number |
| lastmaintenance | String |
| nextmaintenance | String |
| employee_id | Number |
| employee_name | String |
| ts_lastupdate | String |
/MaintenanceSheet/
API Path: /MaintenanceSheet/
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/MaintenanceSheet
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VItfWxfbrfzSfbVlVfzRqDrUfVrjfGfPfPbkzDmmjfVGDGGbbb
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/238”,
“Records”:
[
{
"id": 1,
"list": "KJELL",
"group": "SCHTUFF",
"nr1": "2012014",
"nr2": "",
"description": "Test Buderus Loppem 2",
"address_id": 2687,
"address_name": "USE IT GROUP",
"address_address": "Molenweg 9",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8377",
"address_city": "Meetkerke",
"address_telephone": "+32 50 45 40 66 ",
"address_gsm": "+32 496 12 34 56 ",
"address_email": "",
"project_id": 41,
"project_name": "Testproject Bouwsoft (1)",
"project_pnr": 20120027,
"project_unr": 15,
"project_yourreference": "",
"project_address": "Dorpsstraat 15",
"project_addressline2": "",
"project_countrycode": "BE",
"project_zipcode": "8020",
"project_city": "Oostkamp",
"installationdate": "2012–04–23",
"installation_invoiceid": 0,
"lastmaintenance": "2014–11–20",
"nextmaintenance": "2015–03–21",
"employee_id": 101,
"employee_name": "Coldwell John F.",
"ts_lastupdate": "2020–11–26 10:22:56"
},
{
"id": 4,
"list": "TEST",
"group": "ONDERHOUD KETELS",
"nr1": "2012004",
"nr2": "",
"description": "verwarmingsketel VIESSMAN",
"address_id": 2699,
"address_name": "kreps Isabelle",
"address_address": "Vrijheidsstraat",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8310",
"address_city": "Assebroek (Brugge)",
"address_telephone": "+32 50 70 38 52 ",
"address_gsm": "+32 485 57 10 16 ",
"address_email": "",
"project_id": 15,
"project_name": "testproject Isa",
"project_pnr": 20110001,
"project_unr": 8,
"project_yourreference": "(Uw Ref.)",
"project_address": "Vrijheidsstraat",
"project_addressline2": "",
"project_countrycode": "BE",
"project_zipcode": "8310",
"project_city": "Assebroek (Brugge)",
"installationdate": "2010–06–15",
"installation_invoiceid": 0,
"lastmaintenance": "2020–05–05",
"nextmaintenance": "2020–11–05",
"employee_id": 0,
"employee_name": "",
"ts_lastupdate": "2024–10–22 11:41:47"
}
,
…
]
}
/MaintenanceSheet/{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/MaintenanceSheet/553
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: fDVfWxfVmUzSfAGAbfzRqkDVfGfjkGDAfrOkztOlfAlIDkUkmU
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 553,
"list": "ALGEMEEN",
"group": "",
"nr1": "2016000402",
"nr2": "",
"description": "Accumulatoren",
"address_id": 328891,
"address_name": "DirkAPICust",
"address_address": "Molleweg 9",
"address_addressline2": "",
"address_countrycode": "BE",
"address_zipcode": "8377",
"address_city": "Houtave",
"address_telephone": "",
"address_gsm": "",
"address_email": "",
"project_id": 0,
"project_name": "",
"project_pnr": 0,
"project_unr": 0,
"project_yourreference": "",
"project_address": "",
"project_addressline2": "",
"project_countrycode": "",
"project_zipcode": "",
"project_city": "",
"installationdate": "2017–02–01",
"installation_invoiceid": 0,
"lastmaintenance": "",
"nextmaintenance": "",
"employee_id": 0,
"employee_name": "",
"ts_lastupdate": "2025–02–12 14:26:52"
}
]
}
/MaintenanceSheet/{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/MaintenanceSheet/553/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VOtfWxfIVIzSfPPfUfzRqjOVfAtbkGAVfIfkzIjmjPIIDDUVAt
Success gives statuscode 200 And the following result
APITest Note_Plain