Products

GET /product_api/v1/products/list

List available products.

Response JSON Array of Objects:
 
  • slug (string) – Machine-compatible unique identifier for a product.
  • name (string) – Human-readable name for a product.
Status Codes:
  • 200 OK – yields a list of products.

Example request:

GET /product_api/v1/products/list
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

Example response:

[
  {
    "slug": "test-example-product",
    "name": "Test Example Product"
  }
]

Brondocumenten

The Kadastrale products have subsequent documents or lists linked to them. In order to receive these documents you first need to know which documents or persons (for the lists) are linked. Planviewer provides an endpoints that let you collect all necessary information to order the subsequent products.

Retrieving document information from Order

GET /product_api/v1/documents/list/<UUID>

When order through the product API you’ll recieve a UUID code to download the product. Use this UUID code to see the linked documents.

Response JSON Array of Objects:
 
  • uuid (string) –

    UUID from kadastraal product order.

    Example request:

GET /product_api/v1/documents/list/<UUID>
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

Example response:

[
    {
        "identificatie": "NL.IMKAD.TIAStuk.18020210018810",
        "aard": "Migratie Koers",
        "IngeschrevenOp": {
            "datum": "1993-09-03",
            "tijd": "00:00:00"
        },
        "documentwaardes": {
            "deel": "12291",
            "nummer": "14",
            "reeks": {
                "code": "AHM",
                "waarde": "Arnhem"
            },
            "registercode": {
                "code": "2",
                "waarde": "Hyp4"
            },
            "soortregister": {
                "code": "2",
                "waarde": "Onroerende Zaken"
            }
        }
    }
]

Note

You can only use this on orders you made which have Kadastrale producten. Other UUID will always return an empty array. It is not possible to receive information about brondocuments without ordering the primary document first.

Retrieving Person information from Order for ObjectlijstRechthebbende

GET /product_api/v1/objectlijstrechthebbende/list/<UUID>

When order through the product API you’ll recieve a UUID code to download the product. Use this UUID code to see the linked persons.

Response JSON Array of Objects:
 
  • uuid (string) –

    UUID from kadastraal product order.

    Example request:

GET /product_api/v1/objectlijstrechthebbende/list/<UUID>
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

Example response:

[
    {
        "persoonsvorm": "niet natuurlijk persoon",
        "kadastrale-identificatie": "NL.IMKAD.Persoon.voorbeeld",
        "naam": "voorbeeld B.V.",
        "persoonbeschrijving": {
            "statutairezetel": "ARNHEM",
            "rsin": "00****37",
            "kvknummer": "09****18"
        }
    }
]

Note

You can only use this on orders you made which have Kadastrale producten. Other UUID will always return an empty array. It is not possible to receive information about persons without ordering the primary document first.

Retrieving Person information from Order for objectlijstbetrokkene

GET /product_api/v1/objectlijstbetrokkene/list/<UUID>

When order through the product API you’ll recieve a UUID code to download the product. Use this UUID code to see the linked persons.

Response JSON Array of Objects:
 
  • uuid (string) –

    UUID from kadastraal product order.

    Example request:

GET /product_api/v1/objectlijstbetrokkene/list/<UUID>
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

Example response:

[
    {
        "persoonsvorm": "niet natuurlijk persoon",
        "kadastrale-identificatie": "NL.IMKAD.Persoon.voorbeeld",
        "naam": "voorbeeld B.V.",
        "persoonbeschrijving": {
            "statutairezetel": "ARNHEM",
            "rsin": "00****37",
            "kvknummer": "09****18"
        }
    }
]

Note

You can only use this on orders you made which have Kadastrale producten. Other UUID will always return an empty array. It is not possible to receive information about persons without ordering the primary document first.

Ordering Brondocuments

POST /product_api/v1/documents/order

As Brondocuments are not bound by a location but are subsequent documents linked to a primary kadastraal document the order procedure for them is slightly different from other products. To order a brondocument you need to supply us with all identification markers for this document as provided in the call above or from you own database.

Response JSON Array of Objects:
 
  • identificatie (string) – (optional) IMKAD id for desired document
  • deel (string) – Deel part of Deel en Nummer
  • deel – Nummer part of Deel en Nummer
  • reeks (string) – If Deel is below 50.000 a Reekscode or Reekswaarde must be given
  • registercode (string) – A registercode code or a registercode waarde must be given.
  • soortregister (string) – A soortregister code or a soortregister waarde must be given.
POST /product_api/v1/documents/order
Host: planviewer.nl
Accept: application/json
Content-Type: application/json
{
      "identificatie": "NL.IMKAD.TIAStuk.20111116002120",
  "deel": "60742",
  "nummer": "164",
  "reeks": "",
  "registercode": "Hyp4",
  "soortregister": "Onroerende Zaken"
}

Example response:

[
  {
      "job": {
          "uuid": "5d2943be-d7d6-4b88-b929-73b8b870893f"
      }
  }
]

Use this UUID to get the order status or download the product

Ordering ObjectlijstRechthebbende

POST /product_api/v1/objectlijstrechthebbende/order

As ObjectlijstRechthebbende are not bound by a location but are subsequent documents linked to a person the order procedure for them is slightly different from other products. To order an ObjectlijstRechthebbende you need to supply us with the persons kadastrale-identificatie.

Response JSON Array of Objects:
 
  • identificatie (string) – kadastrale-identificatie
POST /product_api/v1/objectlijstrechthebbende/order
Host: planviewer.nl
Accept: application/json
Content-Type: application/json
{
  "kadastrale-identificatie": "NL.IMKAD.Persoon.voorbeeld",
  "naam": "voorbeeld B.V."
}

Example response:

[
  {
      "job": {
          "uuid": "5d2943be-d7d6-4b88-b929-73b8b870893f"
      }
  }
]

Use this UUID to get the order status or download the product

Note

The product returned is a zip file containing a pdf with the list in an easily to read format and an excel file containing the information is rows

Ordering ObjectlijstBetrokkene

POST /product_api/v1/objectlijstbetrokkene/order

As Objectlijstbetrokkene are not bound by a location but are subsequent documents linked to a person the order procedure for them is slightly different from other products. To order an Objectlijstbetrokkene you need to supply us with the persons kadastrale-identificatie.

Response JSON Array of Objects:
 
  • identificatie (string) – kadastrale-identificatie
POST /product_api/v1/objectlijstbetrokkene/order
Host: planviewer.nl
Accept: application/json
Content-Type: application/json
{
  "kadastrale-identificatie": "NL.IMKAD.Persoon.voorbeeld",
  "naam": "voorbeeld B.V."
}

Example response:

[
  {
      "job": {
          "uuid": "5d2943be-d7d6-4b88-b929-73b8b870893f"
      }
  }
]

Use this UUID to get the order status or download the product

Note

The product returned is a zip file containing a pdf with the list in an easily to read format and an excel file containing the information is rows