Intentions

POST /product_api/v1/intentions/list

Search for available product intentions for a given location.

Request JSON Object:
 
  • uuids (string[]) – Array of uuids of location search results you desire the product intentions for.
  • products (string[]) – Array of slugs of products you desire the product intentions for.
Response JSON Array of Objects:
 
  • uuid (string) – Location search result uuid this set of product intentions is for.
  • intentions (object[]) – Array of product intentions. A product intention has a uuid, a set of properties and refers to the original product. The set of properties varies for each product.
Status Codes:
  • 200 OK – yields a list of product intentions.
  • 400 Bad Request – passed an invalid request object (i.e. not containing products or uuids).

Example request:

POST /product_api/v1/intentions/list
Host: planviewer.nl
Accept: application/json
Content-Type: application/json
{
  "uuids": ["a0f19f8f-ea7c-49e7-bfaf-0df91ddf8af3"],
  "products": ["test-example-product"]
}

Example response:

[
  {
    "uuid": "a0f19f8f-ea7c-49e7-bfaf-0df91ddf8af3",
    "intentions": [
      {
        "uuid": "cee64023-d897-48cb-af5d-7c2c7cda19e6",
        "product": "test-example-product",
        "properties": {
          "datum": "2014-06-25",
          "dossier_status": "deels onherroepelijk in werking",
          "plan_id": "NL.IMRO.0268.BP7000-VG02",
          "title": "bestemmingsplan vastgesteld 25-06-2014"
        }
      },
      {
        "uuid": "0fe30323-a86e-4048-a7e7-6d60c3365dcb",
        "product": "test-example-product",
        "properties": {
          "datum": "2017-09-13",
          "dossier_status": "vastgesteld",
          "plan_id": "NL.IMRO.0268.FBPParkeren-VG01",
          "title": "bestemmingsplan vastgesteld 13-09-2017"
        }
      },
    ]
  }
]