VismaBouwsoftAPICalls.v1_GET_AssignmentProducts Method
v1_GET_AssignmentProducts() as String

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

HTTP method API version
GET v1

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

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

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

Fields

The following fields are available:

Field Name Type
id Number
assignment_id Number
actualcostproducts_id_mapping Number
date String
product_id Number
nr String
description String
unit String
unit_localized String
quantity Number
job_id Number
job_code String
job_name String
ok Boolean
invoice_id Number
invoice_nr Number

/AssignmentProducts/

API Path: /AssignmentProducts/

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

with the following parameters :

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

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/528”, “Records”: [
  {
    "id": 4,
    "assignment_id": 8,
    "actualcostproducts_id_mapping": 286,
    "date": "2014–04–03",
    "product_id": 29339,
    "nr": "272",
    "description": "cement 250 25KG/zak",
    "unit": "st.",
    "unit_localized": "pc.",
    "quantity": 380,
    "job_id": 0,
    "job_code": "",
    "job_name": "",
    "ok": true,
    "invoice_id": 0,
    "invoice_nr": 0
  },
  {
    "id": 5,
    "assignment_id": 8,
    "actualcostproducts_id_mapping": 241,
    "date": "2014–04–03",
    "product_id": 29339,
    "nr": "272",
    "description": "cement 250 25KG/zak",
    "unit": "st.",
    "unit_localized": "pc.",
    "quantity": 380,
    "job_id": 0,
    "job_code": "",
    "job_name": "",
    "ok": true,
    "invoice_id": 0,
    "invoice_nr": 0
  }
,

]
}

/AssignmentProducts/{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/AssignmentProducts/559

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 559,
    "assignment_id": 1294,
    "actualcostproducts_id_mapping": 6214,
    "date": "2022–10–24",
    "product_id": 2809432,
    "nr": "190165",
    "description": "Accumulatoren Blue",
    "unit": "pallet",
    "unit_localized": "pallet",
    "quantity": 100,
    "job_id": 48,
    "job_code": "APIJOB",
    "job_name": "",
    "ok": true,
    "invoice_id": 0,
    "invoice_nr": 0
  }
]
}