VismaBouwsoftAPICalls.v1_GET_ProductAlternativeUnits Method
v1_GET_ProductAlternativeUnits() as String

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

HTTP method API version
GET v1

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

API Path: /ProductAlternativeUnits/
or
API Path: /ProductAlternativeUnits/{id}

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

Fields

The following fields are available:

Field Name Type
id Number
product_id Number
unit String
unit_localized String
factor Number
bulkdiscount Boolean
bulkdiscount_fromquantity Number
price_cost Number
margin_catalogue Number
price_catalogue Number
barcode String

/ProductAlternativeUnits/

API Path: /ProductAlternativeUnits/

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: product_id eq 1
ParameterName: limit, ParameterValue:
ParameterName: sort, ParameterValue: unit

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–2/3”, “Records”: [
  {
    "id": 255,
    "product_id": 1,
    "unit": "Doos",
    "unit_localized": "box",
    "factor": 100,
    "bulkdiscount": false,
    "bulkdiscount_fromquantity": 0,
    "price_cost": 350.0,
    "margin_catalogue": 30.0,
    "price_catalogue": 455.0,
    "barcode": ""
  },
  {
    "id": 3,
    "product_id": 1,
    "unit": "m2",
    "unit_localized": "m²",
    "factor": 0.1,
    "bulkdiscount": false,
    "bulkdiscount_fromquantity": 0,
    "price_cost": 0.35,
    "margin_catalogue": 30.0,
    "price_catalogue": 0.455,
    "barcode": ""
  }
,

]
}

https://ra.bouwsoft.be/api/v1/ProductAlternativeUnits

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue:
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: product_id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/574”, “Records”: [
  {
    "id": 3,
    "product_id": 1,
    "unit": "m2",
    "unit_localized": "m²",
    "factor": 0.1,
    "bulkdiscount": false,
    "bulkdiscount_fromquantity": 0,
    "price_cost": 0.35,
    "margin_catalogue": 30.0,
    "price_catalogue": 0.455,
    "barcode": ""
  },
  {
    "id": 255,
    "product_id": 1,
    "unit": "Doos",
    "unit_localized": "box",
    "factor": 100,
    "bulkdiscount": false,
    "bulkdiscount_fromquantity": 0,
    "price_cost": 350.0,
    "margin_catalogue": 30.0,
    "price_catalogue": 455.0,
    "barcode": ""
  }
,

]
}

/ProductAlternativeUnits/{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/ProductAlternativeUnits/255

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 255,
    "product_id": 1,
    "unit": "Doos",
    "unit_localized": "box",
    "factor": 100,
    "bulkdiscount": false,
    "bulkdiscount_fromquantity": 0,
    "price_cost": 350.0,
    "margin_catalogue": 30.0,
    "price_catalogue": 455.0,
    "barcode": ""
  }
]
}