VismaBouwsoftAPICalls.v1_GET_Products

Method

v1_GET_Products() as String

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

HTTP method	API version
GET	v1

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

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

You can make this API call:
* without the key field id to get a list of Products
* with the key field id as the path parameter (the specific id of the Product 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
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
brand	String
type	String
unit	String
salesunit_id	Number
salesunit	String
purchaseunit_id	Number
purchaseunit	String
unit_localized	String
salesunit_localized	String
purchaseunit_localized	String
active	Boolean
barcode	String
activesupplier_id	Number
activesupplier_name	String
ts_lastupdate	String
lot_id	String
lot_nr	String
lot_description	String
lot_stocklocationid	Number
stock_location	String
stock_locationid	Number
lotprice_unit	Number
lotprice_total	Number
quantity	Number
quantity_reserved	Number
quantity_available	Number
purchase_price	Number
purchase_unit	String
product_id	Number

/Products/

API Path: /Products/

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

with the following parameters :

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

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/503419”, “Records”: [
  {
    "id": 1,
    "list": "VERF",
    "group": "01 Levis",
    "nr1": "01 Pl 01",
    "nr2": "",
    "description": "Levis Plafond voor baksteen, ruwe beton, cementbezetting, gipskartonplaat, pleisterwerk",
    "price_cost": 3.5,
    "price_catalogue": 4.55,
    "price_sales1": 4.55,
    "price_sales2": 4.2,
    "price_sales3": 3.85,
    "margin_catalogue": 30.0,
    "margin1": 30.0,
    "margin2": 20.0,
    "margin3": 10.0,
    "discount1": 0.0,
    "discount2": 7.6923,
    "discount3": 15.384600000000001,
    "brand": "",
    "type": "",
    "unit": "st.",
    "salesunit_id": 0,
    "salesunit": "st.",
    "purchaseunit_id": 3,
    "purchaseunit": "m2",
    "unit_localized": "pc.",
    "salesunit_localized": "pc.",
    "purchaseunit_localized": "m²",
    "active": true,
    "barcode": "",
    "activesupplier_id": 0,
    "activesupplier_name": "",
    "ts_lastupdate": "2020–11–26 10:15:16"
  },
  {
    "id": 2,
    "list": "VERF",
    "group": "01 Levis",
    "nr1": "01 Mu 01",
    "nr2": "",
    "description": "Levis Muur voor baksteen, behangpapier, ruwe beton, cellenbeton, betonblokken, cementbezetting, gipskartonplaat, glasvezel, pleisterwerk",
    "price_cost": 2.5,
    "price_catalogue": 3.25,
    "price_sales1": 3.25,
    "price_sales2": 3.0,
    "price_sales3": 2.75,
    "margin_catalogue": 30.0,
    "margin1": 30.0,
    "margin2": 20.0,
    "margin3": 10.0,
    "discount1": 0.0,
    "discount2": 7.6923,
    "discount3": 15.384600000000001,
    "brand": "",
    "type": "",
    "unit": "L",
    "salesunit_id": 859,
    "salesunit": "doos",
    "purchaseunit_id": 861,
    "purchaseunit": "st.",
    "unit_localized": "L",
    "salesunit_localized": "box",
    "purchaseunit_localized": "pc.",
    "active": true,
    "barcode": "",
    "activesupplier_id": 0,
    "activesupplier_name": "",
    "ts_lastupdate": "2025–02–12 14:23:31"
  }
,
…
]
}

/Products/{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/Products/2809432

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 2809432,
    "list": "ALGEMEEN",
    "group": "",
    "nr1": "190165",
    "nr2": "",
    "description": "Tegels Citroengeel 40*60",
    "price_cost": 12.35,
    "price_catalogue": 17.289999999999999,
    "price_sales1": 13.585000000000001,
    "price_sales2": 14.82,
    "price_sales3": 16.055,
    "margin_catalogue": 40.0,
    "margin1": 10.0,
    "margin2": 20.0,
    "margin3": 30.0,
    "discount1": 21.428599999999999,
    "discount2": 14.2857,
    "discount3": 7.1429,
    "brand": "",
    "type": "",
    "unit": "st.",
    "salesunit_id": 0,
    "salesunit": "st.",
    "purchaseunit_id": 0,
    "purchaseunit": "st.",
    "unit_localized": "pc.",
    "salesunit_localized": "pc.",
    "purchaseunit_localized": "pc.",
    "active": true,
    "barcode": "",
    "activesupplier_id": 0,
    "activesupplier_name": "",
    "ts_lastupdate": "2025–02–12 14:27:45"
  }
]
}

/Products/{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/Products/1758656/image

with the following parameters :

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

Success gives statuscode 200 And the following result

image

/Products/{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/Products/1758656/note_html

with the following parameters :

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

Success gives statuscode 200 And the following result

<HTML><BODY> <DIV STYLE="text-align: left;">AXIS Camera Station Optimized for easy and efficient surveillance Optimized for small- to mid-sized installations AXIS Camera Station, video management software, is the ideal solution to meet the needs for efficient surveillance of small- and midsized installations, such as retail shops, hotels, schools and manufacturing sites a proven solution with more than 50,000 installations worldwide. It is designed to perfectly match Axis' wide range of network video products and product features to optimize system reliability. Ease of operation & high-definition identification A setup wizard with automatic camera discovery guides you through every step of the setup process. This allows the system to be up and running within minutes. AXIS Camera Station is developed with focus on ease of use and intuitive operation, ensuring that anyone can effectively manage incidents and quickly export high definition evidence. AXIS Camera Station allows the user to add useful functionality such as AXIS A8004‑VE Network Video Door Station for audiovisual identification and remote entry control, as well as AXIS C3003‑E Network Horn Speaker that enables an operator to remotely address people and deter unwanted activity.</DIV> </BODY></HTML>

/Products/{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/Products/1758656/note_plain

with the following parameters :

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

Success gives statuscode 200 And the following result

AXIS Camera Station

Optimized for easy and efficient surveillance

Optimized for small- to mid-sized installations

AXIS Camera Station, video management software, is the ideal solution to meet the needs for efficient surveillance of small- and midsized installations, such as retail shops, hotels, schools and manufacturing sites – a proven solution with more than 50,000 installations worldwide. It is designed to perfectly match Axis’ wide range of network video products and product features to optimize system reliability.

Ease of operation & high-definition identification

A setup wizard with automatic camera discovery guides you through every step of the setup process. This allows the system to be up and running within minutes. AXIS Camera Station is developed with focus on ease of use and intuitive operation, ensuring that anyone can effectively manage incidents and quickly export high definition evidence. AXIS Camera Station allows the user to add useful functionality such as AXIS A8004‑VE Network Video Door Station for audiovisual identification and remote entry control, as well as AXIS C3003‑E Network Horn Speaker that enables an operator to remotely address people and deter unwanted activity.

/Products/{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/Products/1758656/note_rtf

with the following parameters :

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

Success gives statuscode 200 And the following result

{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Times New Roman;}{\f1\fnil Arial;}}{\colortbl ;\red0\green0\blue0;\red136\green136\blue136;\red255\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f1\fs48\cf1\b\ul AXIS Camera Station\par\par\fs32\cf2\b0\i\ul0 Optimized for easy and efficient surveillance\par\par\par\cf1\i0 Optimized for small- to mid-sized installations\par\par\f0\fs24 AXIS Camera Station, video management software, is the ideal solution to meet the needs for efficient surveillance of small- and midsized installations, such as retail shops, hotels, schools and manufacturing sites \uc0\u8211 a proven solution with more than 50,000 installations worldwide. It is designed to perfectly match Axis’ wide range of network video products and product features to optimize system reliability. \par\par\f1\fs32 Ease of operation & high-definition identification\par\par\f0\fs24 A setup wizard with automatic camera discovery guides you through every step of the setup process. This allows the system to be up and running within minutes. AXIS Camera Station is developed with focus on ease of use and intuitive operation, ensuring that anyone can effectively manage incidents and quickly export high definition evidence. AXIS Camera Station allows the user to add useful functionality such as \cf3 AXIS A8004\u8209 VE Network Video Door Station\cf1 for audiovisual identification and remote entry control, as well as \cf3 AXIS C3003\u8209 E Network Horn Speaker \cf1 that enables an operator to remotely address people and deter unwanted activity.}