VismaBouwsoftAPICalls.v1_GET_Earthworksdetail

Method

v1_GET_Earthworksdetail() as String

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

HTTP method	API version
GET	v1

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

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

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

Fields

The following fields are available:

Field Name	Type
id	Number
earthworks_id	Number
product_id	Number
product_nr	String
product_description	String
linenr	Number
quantity	Number
unit	String
unit_localized	String

/Earthworksdetail/

API Path: /Earthworksdetail/

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue:
ParameterName: filter, ParameterValue: earthworks_id eq 26

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–2/3”, “Records”: [
  {
    "id": 60,
    "earthworks_id": 26,
    "product_id": 2,
    "product_nr": "01 Mu 01",
    "product_description": "Levis Muur voor baksteen, behangpapier, ruwe beton, cellenbeton, betonblokken, cementbezetting, gipskartonplaat, glasvezel, pleisterwerk",
    "linenr": 1,
    "quantity": 2.5,
    "unit": "m2",
    "unit_localized": "m²"
  },
  {
    "id": 61,
    "earthworks_id": 26,
    "product_id": 7,
    "product_nr": "249",
    "product_description": "HBS VITE PER LEGNO 8X400",
    "linenr": 2,
    "quantity": 2,
    "unit": "m3",
    "unit_localized": "m³"
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue:
ParameterName: filter, ParameterValue:
ParameterName: limit, ParameterValue: 5
ParameterName: nextid, ParameterValue:

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/56”, “Records”: [
  {
    "id": 1,
    "earthworks_id": 2,
    "product_id": 1515061,
    "product_nr": "lux005",
    "product_description": "test lux 05",
    "linenr": 2,
    "quantity": 20.199999999999999,
    "unit": "m3",
    "unit_localized": "m³"
  },
  {
    "id": 2,
    "earthworks_id": 6,
    "product_id": 30,
    "product_nr": "Viess CV O 003",
    "product_description": "Vitoladens 300 W",
    "linenr": 1,
    "quantity": 500,
    "unit": "m³",
    "unit_localized": "m³"
  }
,
…
]
}

/Earthworksdetail/{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/Earthworksdetail/65

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 65,
    "earthworks_id": 105,
    "product_id": 14,
    "product_nr": "CE 002",
    "product_description": "Untitled (Circuit 091113), 2009 (110 x 130 cm)",
    "linenr": 1,
    "quantity": 2.7,
    "unit": "m3",
    "unit_localized": "m³"
  }
]
}

https://ra.bouwsoft.be/api/v1/Earthworksdetail/65

with the following parameters :

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

Success gives statuscode 200 And the following result