Products

GET /product_api/v1/products/list

List available products.

status 200:yields a list of products.

Example request:

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

Example response:

[
  {
    "slug": "bestemmingsplanrapport",
    "name": "Bestemmingsplanrapport"
  },
  {
    "slug": "vraagprijsrapport",
    "name": "Vraagprijsrapport"
  },
  {
    "slug": "maatvoering-perceel",
    "name": "Maatvoering Perceel"
  },
  {
    "slug": "percelenrapport",
    "name": "Percelenrapport"
  },
  {
    "slug": "kadastraledocumenten",
    "name": "kadastraledocumenten"
  },
  {
    "slug": "bestemmingsplankaart",
    "name": "Bestemmingsplankaart"
  },
  {
    "slug": "uittreksel-kadastrale-kaart",
    "name": "uittreksel kadastrale kaart"
  },
  {
    "slug": "koopsomoverzicht",
    "name": "koopsomoverzicht"
  },
  {
    "slug": "objectlijstrechthebbende",
    "name": "Objectlijst rechthebbende"
  },
  {
    "slug": "eigendomsinformatie",
    "name": "Eigendomsinformatie"
  },
  {
    "slug": "hypotheekinformatie",
    "name": "Hypotheekinformatie"
  },
  {
    "slug": "eigendomsinformatie-kik5",
    "name": "Eigendomsinformatie KIK5"
  },
  {
    "slug": "uittreksel-kadastrale-kaart-kik6",
    "name": "Uittreksel kadastrale kaart 6.0"
  },
  {
    "slug": "brondocument",
    "name": "brondocument"
  },
  {
    "slug": "objectlijstpersoon-json",
    "name": "objectlijstpersoon-json"
  },
  {
    "slug": "objectlijstpersoon-pdf",
    "name": "objectlijstpersoon-pdf"
  },
  {
    "slug": "hypotheekinformatie-json",
    "name": "hypotheekinformatie-json"
  },
  {
    "slug": "eigendomsinformatie-json",
    "name": "eigendomsinformatie-json"
  }
]

Lijst van personen of documenten

Aan de hand van eerder besteld product (eigendomsinformatie of hypotheekinformatie) kunnen de volgende lijsten opgehaald worden:

  • Een lijst van Personen genoemd als tenaamstelling in betreffende product
  • Een lijst van stukken genoemd in betreffende product

Voorbeeld request/response order

POST /product_api/v1/jobs/order
Host: planviewer.nl
Accept: application/json
Content-Type: application/json
[
  {
    "uuid": "79306154-74f4-47e4-ae3c-07cbc7efdd81",
    "job": {
      "uuid": "2a6decf0-296e-42c5-a081-2162cf7fc692"
    }
  }
]

zie Placing an order

Personen

Ophalen lijst van personen genoemd als “tenaamstellingen” in producten “eigendomsinformatie” en “hypotheekinformatie”

GET /product_api/v1/personen/list/<UUID>
param string uuid:
 UUID van de job van eerder besteld product zie Lijst van personen of documenten

Voorbeeld request

GET /product_api/v1/personen/list/2a6decf0-296e-42c5-a081-2162cf7fc692 HTTP/1.1
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

Example response

[
  {
    "persoonsvorm": "natuurlijk persoon",
    "kadastrale-identificatie": "333796320",
    "naam": "Mevrouw Voornamen Geslachtsnaam 333796320",
    "persoonbeschrijving": {
      "datumgeboorte": "01-01-1900",
      "datumoverleden": null
    }
  },
  {
    "persoonsvorm": "natuurlijk persoon",
    "kadastrale-identificatie": "333796274",
    "naam": "De Heer Voornamen Geslachtsnaam 333796274",
    "persoonbeschrijving": {
      "datumgeboorte": "01-01-1900",
      "datumoverleden": null
      "statutairezetel": "ARNHEM",
      "rsin": "00****37",
      "kvknummer": "09****18"
    }
  }
]

Note

Enkel te gebruiken met job.UUID van eerder besteld product.

Documenten

GET /product_api/v1/documents/list/<UUID>
param string uuid:
 UUID van de job van eerder besteld product zie Lijst van personen of documenten

Voorbeeld request

GET /product_api/v1/documents/list/2a6decf0-296e-42c5-a081-2162cf7fc692 HTTP/1.1
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

Voorbeeld 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

Enkel te gebruiken met job.UUID van eerder besteld product.

Hypotheekinformatie

Voor teruggave in JSON bestel je het product “hypotheekinformatie-json”

Eigendomsinformatie

Voor teruggave in JSON bestel je het product “eigendomsinformatie-json”

Brondocumenten (akte van levering)

Brondocumenten (akte van levering) kunnen worden besteld aan de hand van de Hyp4 aanduiding. Deze kun je vinden in de producten “Hypotheekinformatie” of “Eigendomsinformatie”.

POST /product_api/v1/documents/order
Request JSON Object:
 
  • 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.

Voorbeeld request

POST /product_api/v1/documents/order HTTP/1.1
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:

[
  {
    "uuid": "79306154-74f4-47e4-ae3c-07cbc7efdd81",
    "job": {
      "uuid": "2a6decf0-296e-42c5-a081-2162cf7fc692"
    }
  }
]

Objectlijst Persoon

Een Objectlijst Persoon kan worden besteld aan de hand van “kadastrale identificatie” Persoon (NL.IMKAD.Persoon)

Deze kun je vinden in de producten “`hypotheekinformatie-json`_” of “`eigendomsinformatie-json`_”.

POST /product_api/v1/objectlijstpersoon/order
<json string kadastrale-identificatie:
 NL.IMKAD.Persoon
<json string format:
 pdf, json (optioneel default “pdf”)

Example request:

POST /product_api/v1/objectlijstpersoon/order HTTP/1.1
Host: planviewer.nl
Accept: application/json
Content-Type: application/json
{
  "kadastrale-identificatie": "11304723",
  "naam": "voorbeeld B.V.",
  "format": "json"
}

Example response:

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

Note

Gebruik dit UUID om order status op te halen, of product te downloaden Wanneer gekozen is voor format: “json”, bevat de response het veld [“geleverdProduct”][“pdf”] met de base64 encoded PDF data.

Ordering ObjectlijstRechthebbende

Warning

Vanaf 31 maart kunnen wij dit product niet meer leveren

Retrieving Person information from Order for ObjectlijstRechthebbende

Warning

Vanaf 31 maart kunnen wij dit product niet meer leveren

Objectlijst Betrokkene

Ordering ObjectlijstBetrokkene

Warning

Vanaf 31 maart kunnen wij dit product niet meer leveren

Retrieving Person information from Order for objectlijstbetrokkene

Warning

Vanaf 31 maart kunnen wij dit product niet meer leveren