VismaBouwsoftAPICalls.v1_GET_ProgressReportInstances

Method

v1_GET_ProgressReportInstances() as String

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

HTTP method	API version
GET	v1

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

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

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

Fields

The following fields are available:

Field Name	Type
id	Number
company_id	Number
progressreport_id	Number
progressreport_nr	String
title	String
description	String
price_assigned	Number
price_current	Number
price_percent	Number
applyto_progressreport	Boolean
applyto_chapter	Number
applyto_part	Number
applyto_group	String
application_localized	String
address_id	Number
address_name	String
address_address	String
address_addressline2	String
address_countrycode	String
address_zipcode	String
address_city	String
project_id	Number
project_pnr	Number
project_unr	Number
project_ref	String
project_name	String

/ProgressReportInstances/

API Path: /ProgressReportInstances/

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: progressreport_nr eq ‘20160037–1’
ParameterName: limit, ParameterValue:

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–1/2”, “Records”: [
  {
    "id": 430,
    "company_id": 12,
    "progressreport_id": 643,
    "progressreport_nr": "20160037–1",
    "title": "",
    "description": "",
    "price_assigned": 1500.0,
    "price_current": 3000.0,
    "price_percent": 50,
    "applyto_progressreport": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines",
    "address_id": 109306,
    "address_name": "\"H.B. Plâtre\"",
    "address_address": "Rue Lacherez 25",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "6150",
    "address_city": "Anderlues",
    "project_id": 0,
    "project_pnr": 0,
    "project_unr": 0,
    "project_ref": "",
    "project_name": ""
  },
  {
    "id": 431,
    "company_id": 12,
    "progressreport_id": 643,
    "progressreport_nr": "20160037–1",
    "title": "",
    "description": "",
    "price_assigned": 1500.0,
    "price_current": 3000.0,
    "price_percent": 50,
    "applyto_progressreport": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines",
    "address_id": 79374,
    "address_name": "’t Grassprietje",
    "address_address": "Groenstraat 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "9810",
    "address_city": "Nazareth",
    "project_id": 0,
    "project_pnr": 0,
    "project_unr": 0,
    "project_ref": "",
    "project_name": ""
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: limit, ParameterValue: 5

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/470”, “Records”: [
  {
    "id": 2,
    "company_id": 1,
    "progressreport_id": 30,
    "progressreport_nr": "20120024–1",
    "title": "Instantie 1",
    "description": "",
    "price_assigned": 1350.0,
    "price_current": 4500.0,
    "price_percent": 30,
    "applyto_progressreport": false,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "GRONDWERKEN",
    "application_localized": "GRONDWERKEN",
    "address_id": 2709,
    "address_name": "Bouwsoft ADV",
    "address_address": "Molenweg 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8377",
    "address_city": "Meetkerke",
    "project_id": 82,
    "project_pnr": 20130007,
    "project_unr": 0,
    "project_ref": "",
    "project_name": "Project testen van de instanties"
  },
  {
    "id": 5,
    "company_id": 1,
    "progressreport_id": 31,
    "progressreport_nr": "20120025–1",
    "title": "Instantie 3",
    "description": "",
    "price_assigned": 6125.0,
    "price_current": 12250.0,
    "price_percent": 50,
    "applyto_progressreport": false,
    "applyto_chapter": 1,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "Chapter 1",
    "address_id": 2709,
    "address_name": "Bouwsoft ADV",
    "address_address": "Molenweg 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8377",
    "address_city": "Meetkerke",
    "project_id": 84,
    "project_pnr": 20130009,
    "project_unr": 31,
    "project_ref": "",
    "project_name": "Project: Test Henk"
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: progressreport_id eq 643

Success gives statuscode 200 And the following result

/ProgressReportInstances/{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/ProgressReportInstances/196

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 196,
    "company_id": 1,
    "progressreport_id": 2,
    "progressreport_nr": "20120002–1",
    "title": "Instantie 1",
    "description": "",
    "price_assigned": 0.0,
    "price_current": 0.0,
    "price_percent": 0,
    "applyto_progressreport": false,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "",
    "address_id": 3757,
    "address_name": "",
    "address_address": "Hogeweg 21",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8000",
    "address_city": "Brugge",
    "project_id": 6,
    "project_pnr": 20120004,
    "project_unr": 6,
    "project_ref": "",
    "project_name": "Project: Ruwbouw"
  }
]
}