VismaBouwsoftAPICalls.v1_GET_Items

Method

v1_GET_Items() as String

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

HTTP method	API version
GET	v1

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

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

You can make this API call:
* without the key field id to get a list of Items
* with the key field id as the path parameter (the specific id of the Item 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
unit1	String
unit2	String
brand	String
type	String
barcode	String
active	String
ts_lastupdate	String

/Items/

API Path: /Items/

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: description eq ‘machine voor api’
ParameterName: limit, ParameterValue: 1
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 14025,
    "list": "ALGEMEEN",
    "group": "",
    "nr1": "865",
    "nr2": "",
    "description": "machine voor api",
    "unit1": "",
    "unit2": "",
    "brand": "",
    "type": "",
    "barcode": "",
    "active": "True",
    "ts_lastupdate": "2023–05–24 13:36:33"
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue:
ParameterName: limit, ParameterValue: 1
ParameterName: nextid, ParameterValue: 11
ParameterName: offset, ParameterValue:
ParameterName: sort, ParameterValue: list|group|nr1

Success gives statuscode 200 And the following result

{ “Content-Range”:“1532–1532/11457”, “Records”: [
  {
    "id": 11,
    "list": "STANDAARDBESTEK 250 VERSIE 2.2",
    "group": "0132",
    "nr1": "SB250.0132.02701",
    "nr2": "0132.02701",
    "description": "Voorbehouden som voor het uitvoeren van proeven a posteriori volgens art. 27 § 2",
    "unit1": "euro",
    "unit2": "VS",
    "brand": "",
    "type": "",
    "barcode": "",
    "active": "True",
    "ts_lastupdate": "2019–05–15 09:21:27"
  }
]
}

/Items/{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/Items/2

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": 2,
    "list": "RENOVATIE",
    "group": "",
    "nr1": "post01",
    "nr2": "",
    "description": "Schilderen van Plafond",
    "unit1": "m2",
    "unit2": "",
    "brand": "",
    "type": "",
    "barcode": "",
    "active": "True",
    "ts_lastupdate": "2021–09–23 14:45:16"
  }
]
}

/Items/{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/Items/2/image

with the following parameters :

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

Success gives statuscode 200 And the following result

image

/Items/{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/Items/2/note_html

with the following parameters :

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

Success gives statuscode 200 And the following result

<HTML><BODY> <DIV STYLE="text-align: left;"><BR> <SPAN STYLE="font-family: Arial;font-size: 10pt;color: #000000;">LEVIS PLAFOND EXPERT<BR> Extra matte verf van topkwaliteit voor plafonds. Maskeert vlekken en oneffenheden, goed afwasbaar, spat niet.<BR> </SPAN></DIV> </BODY></HTML>

/Items/{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/Items/2/note_plain

with the following parameters :

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

Success gives statuscode 200 And the following result

LEVIS PLAFOND EXPERT Extra matte verf van topkwaliteit voor plafonds. Maskeert vlekken en oneffenheden, goed afwasbaar, spat niet.

/Items/{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/Items/2/note_rtf

with the following parameters :

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

Success gives statuscode 200 And the following result

{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Arial;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs20\cf1 LEVIS PLAFOND EXPERT\par Extra matte verf van topkwaliteit voor plafonds. Maskeert vlekken en oneffenheden, goed afwasbaar, spat niet.\par}