VismaBouwsoftAPICalls.v1_GET_Machines

Method

v1_GET_Machines() as String

This API call is used to get fields of a(n) Machine(s)

HTTP method	API version
GET	v1

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

API Path: /Machines/
or
API Path: /Machines/{id}
or
API Path: /Machines/{id}/image
or
API Path: /Machines/{id}/note_html
or
API Path: /Machines/{id}/note_plain
or
API Path: /Machines/{id}/note_rtf

You can make this API call:
* without the key field id to get a list of Machines
* with the key field id as the path parameter (the specific id of the Machine you want to get)

Fields

The following fields are available:

Field Name	Type
type	String
content	Error
id	Number
list	String
group	String
nr	String
description	String
brand	String
chassisnr	String
license_plate	String
purchasedate	String
constructionyear	Number
company_id	Number
company_name	String
price_cost	Number
price_catalogue	Number
price_sales1	Number
price_sales2	Number
price_sales3	Number
margin_catalogue	Number
margin1	Number
margin2	Number
margin3	Number
discount1	Number
discount2	Number
discount3	Number
supplier_id	Number
supplier_name	String
tech_checkup_last_date	String
tech_checkup_expire_date	String
unit	String
geodyn_name	String
ts_lastupdate	String

/Machines/

API Path: /Machines/

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

with the following parameters :

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

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/1938”, “Records”: [
  {
    "id": 1,
    "list": "ALGEMEEN",
    "group": "",
    "nr": "Caddy 01",
    "description": "Volkswagen caddy",
    "type": "De Caddy \"Entry\" (TSI 86 pk)",
    "brand": "Volkswagen",
    "chassisnr": "123456789–1",
    "license_plate": "000 aaa",
    "purchasedate": "2012–01–01",
    "constructionyear": 2012,
    "company_id": 1,
    "company_name": "Bouwsoft",
    "price_cost": 0.0,
    "price_catalogue": 0.0,
    "price_sales1": 0.0,
    "price_sales2": 0.0,
    "price_sales3": 0.0,
    "margin_catalogue": 0.0,
    "margin1": 0.0,
    "margin2": 0.0,
    "margin3": 0.0,
    "discount1": 0.0,
    "discount2": 0.0,
    "discount3": 0.0,
    "supplier_id": 26,
    "supplier_name": "Brugs Motoren Bedrijf",
    "tech_checkup_last_date": "2020–03–05",
    "tech_checkup_expire_date": "2021–04–07",
    "unit": "km",
    "geodyn_name": "Caddy 01",
    "ts_lastupdate": "2020–11–26 10:22:20"
  },
  {
    "id": 2,
    "list": "TRANSPORT",
    "group": "Bedrijfscamionetten",
    "nr": "Caddy 02",
    "description": "Volkswagen caddy",
    "type": "De Caddy \"Entry\" (TSI 86 pk)",
    "brand": "Volkswagen",
    "chassisnr": "123456789–2",
    "license_plate": "000-bbb",
    "purchasedate": "2012–01–01",
    "constructionyear": 2012,
    "company_id": 1,
    "company_name": "Bouwsoft",
    "price_cost": 0.0,
    "price_catalogue": 0.0,
    "price_sales1": 0.0,
    "price_sales2": 0.0,
    "price_sales3": 0.0,
    "margin_catalogue": 0.0,
    "margin1": 0.0,
    "margin2": 0.0,
    "margin3": 0.0,
    "discount1": 0.0,
    "discount2": 0.0,
    "discount3": 0.0,
    "supplier_id": 26,
    "supplier_name": "Brugs Motoren Bedrijf",
    "tech_checkup_last_date": "",
    "tech_checkup_expire_date": "2013–01–01",
    "unit": "dag",
    "geodyn_name": "",
    "ts_lastupdate": "2024–07–02 13:33:46"
  }
,
…
]
}

/Machines/{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/Machines/1995

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 1995,
    "list": "ALGEMEEN",
    "group": "",
    "nr": "Machine 4844212",
    "description": "Diverse Graafmachine 3 old",
    "type": "",
    "brand": "",
    "chassisnr": "",
    "license_plate": "",
    "purchasedate": "",
    "constructionyear": 0,
    "company_id": 1,
    "company_name": "Bouwsoft",
    "price_cost": 0.0,
    "price_catalogue": 0.0,
    "price_sales1": 0.0,
    "price_sales2": 0.0,
    "price_sales3": 0.0,
    "margin_catalogue": 21.9512,
    "margin1": 0.0,
    "margin2": 0.0,
    "margin3": 0.0,
    "discount1": 0.0,
    "discount2": 0.0,
    "discount3": 0.0,
    "supplier_id": 0,
    "supplier_name": "",
    "tech_checkup_last_date": "",
    "tech_checkup_expire_date": "",
    "unit": "u.",
    "geodyn_name": "",
    "ts_lastupdate": "2025–02–12 14:27:02"
  }
]
}

/Machines/{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/Machines/66/image

with the following parameters :

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

Success gives statuscode 200 And the following result

image

/Machines/{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/Machines/66/note_html

with the following parameters :

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

Success gives statuscode 200 And the following result

<HTML><BODY> <DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Times New Roman;font-size: 12pt;color: #000000;">APITest machines noteplain </SPAN></DIV> </BODY></HTML>

/Machines/{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/Machines/66/note_plain

with the following parameters :

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

Success gives statuscode 200 And the following result

APITest machines noteplain

https://ra.bouwsoft.be/api/v1/Machines/1995/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 machines noteplain

/Machines/{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/Machines/66/note_rtf

with the following parameters :

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

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\f0\fs24\cf1 APITest machines noteplain }