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
or
API Path: /MaintenanceSheet/FieldInfo/

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)
* to request the FieldInfo for this call

Fields

The following fields are available:

Field Name	Type Name	Length	Required	Writeable	Force Write	Link
list	tpString	50	No	No	No
group	tpString	50	No	No	No
nr1	tpString	100	No	No	No
nr2	tpString	100	No	No	No
description	tpString	0	No	No	No
address_id	tpLong	0	No	No	No
address_name	tpString	150	No	No	No
address_address	tpString	63	No	No	No
address_addressline2	tpString	63	No	No	No
address_countrycode	tpString	2	No	No	No
address_zipcode	tpString	15	No	No	No
address_telephone	tpString	25	No	No	No
address_gsm	tpString	25	No	No	No
address_email	tpString	100	No	No	No
project_id	tpLong	0	No	No	No
project_name	tpString	100	No	No	No
project_pnr	tpLong	0	No	No	No
project_unr	tpLong	0	No	No	No
project_yourreference	tpString	50	No	No	No
project_address	tpString	63	No	No	No
project_addressline2	tpString	63	No	No	No
project_countrycode	tpString	2	No	No	No
project_zipcode	tpString	15	No	No	No
installationdate	tpDateNullString	0	No	No	No
installation_invoiceid	tpLong	0	No	No	No
lastmaintenance	tpDateNullString	0	No	No	No
nextmaintenance	tpDateNullString	0	No	No	No
employee_id	tpLong	0	No	No	No
employee_name	tpString	150	No	No	No
ts_lastupdate	tpDate	0	No	No	No

/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: PbjfWxftIOzSfDUlIfzRqklGfltAfGjkfkkkzPfPlUAGDIDlfk

Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/251”, “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/571

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": 571,
    "list": "ALGEMEEN",
    "group": "",
    "nr1": "2016000416",
    "nr2": "",
    "description": "Accumulatoren",
    "address_id": 329297,
    "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": "2026–03–24 14:28:03"
  }
]
}

/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/571/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

/MaintenanceSheet/FieldInfo

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/FieldInfo

with the following parameters :

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

Success gives statuscode 200 And the following result

[
  {
    "name": "list",
    "type_id": 2,
    "type_name": "tpString",
    "length": 50,
    "required": false,
    "writeable": false,
    "forcewrite": false,
    "link": ""
  },
  {
    "name": "group",
    "type_id": 2,
    "type_name": "tpString",
    "length": 50,
    "required": false,
    "writeable": false,
    "forcewrite": false,
    "link": ""
  }
,
…
]