VismaBouwsoftAPICalls.v1_POST_MaintenanceSheet Method
v1_POST_MaintenanceSheet() as String

This API call is used to add a(n) MaintenanceSheet

General Description

HTTP method API version
POST v1

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

API Path: /MaintenanceSheet
or
API Path: /MaintenanceSheet/{id}/Upload

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
name String
path_display String
path_lower String
client_modified String
server_modified String
rev String
size Number
is_downloadable Boolean
checksum String

/MaintenanceSheet

API Path: /MaintenanceSheet/

If everything succeeds the HTTP response status is 201
(201 CREATED)

If you forget to send the Authorization, the response status and code is 401
(401 Unauthorized)

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: fDVfWxfVmUzSfAGAbfzRqkDVfGfjkGDAfrOkztOlfAlIDkUkmU

Query Parameters :
ParameterName: columns, ParameterValue: address_id=328891,description=’Accumulatoren’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "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": "2025–02–12",
    "installation_invoiceid": 0,
    "lastmaintenance": "",
    "nextmaintenance": "",
    "employee_id": 0,
    "employee_name": "",
    "ts_lastupdate": "2025–02–12 14:26:49"
  }
]
}

/MaintenanceSheet/{id}/Upload

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

with the following parameters :

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

Body Parameters :
ParameterName: fileParameterValue: tptype.txt

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "name": "tptype.txt",
    "path_display": ".",
    "path_lower": ".",
    "id": "",
    "client_modified": "2025–02–12T14:26:51Z",
    "server_modified": "2025–02–12T14:26:51Z",
    "rev": "",
    "size": 425,
    "is_downloadable": true,
    "checksum": "oSrFJwWUPDX15XvsI4+9IMtaz9extnKA1fUj2rXolXY="
  }
]
}