.. _api-product-products-list:


********
Products
********

.. http:get:: /product_api/v1/products/list

List available products.

:status 200: yields a list of products.

**Example request**:

.. sourcecode:: http

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

**Example response**:

.. literalinclude:: ./source/products-list.json
  :language: json
  :emphasize-lines: 39-40,43-44,55-56,59-60,67-68,71-72



.. _eerdere-order:

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**

.. sourcecode:: http

  POST /product_api/v1/jobs/order
  Host: planviewer.nl
  Accept: application/json
  Content-Type: application/json

.. literalinclude:: ./source/job-order.json
  :language: json
  :emphasize-lines: 5

zie :ref:`placing-an-order`

Personen
========

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

.. http:get:: /product_api/v1/personen/list/<UUID>

:param string uuid: UUID van de job van eerder besteld product zie :ref:`eerdere-order`


**Voorbeeld request**

.. sourcecode:: http

  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**

.. literalinclude:: ./source/personen-list.json

.. note::
  Enkel te gebruiken met `job.UUID` van eerder besteld product.

Documenten
==========

.. http:get:: /product_api/v1/documents/list/<UUID>

:param string uuid: UUID van de job van eerder besteld product zie :ref:`eerdere-order`

**Voorbeeld request**

.. sourcecode:: http

  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**:

.. literalinclude:: ./source/documents-list.json

.. note::
  Enkel te gebruiken met `job.UUID` van eerder besteld product.

.. _hypotheekinformatie:

Hypotheekinformatie
-------------------

Voor teruggave in JSON bestel je het product "hypotheekinformatie-json"

.. _eigendomsinformatie:

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 ":ref:`hypotheekinformatie`" of ":ref:`eigendomsinformatie`".


Bestellen Brondocumenten
^^^^^^^^^^^^^^^^^^^^^^^^

.. http:post:: /product_api/v1/documents/order

  :<json string identificatie: (optional) IMKAD id for desired document
  :<json string deel: Deel part of Deel en Nummer
  :<json string deel: Nummer part of Deel en Nummer
  :<json string reeks: If Deel is below 50.000 a Reekscode or Reekswaarde must be given
  :<json string registercode: A registercode code or a registercode waarde must be given.
  :<json string soortregister: A soortregister code or a soortregister waarde must be given.

**Voorbeeld request**

.. sourcecode:: http

  POST /product_api/v1/documents/order HTTP/1.1
  Host: planviewer.nl
  Accept: application/json
  Content-Type: application/json

.. literalinclude:: ./source/documents-order-request.json

**Example response**:

.. literalinclude:: ./source/documents-order-response.json




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`_".


bestellen Objectlijst Persoon
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. http:post:: /product_api/v1/objectlijstpersoon/order

    :<json string kadastrale-identificatie: NL.IMKAD.Persoon
    :<json string format: pdf, json (optioneel default "pdf")

  **Example request**:

.. sourcecode:: http

     POST /product_api/v1/objectlijstpersoon/order HTTP/1.1
     Host: planviewer.nl
     Accept: application/json
     Content-Type: application/json

.. literalinclude:: ./source/objectlijstpersoon-order-request.json

**Example response**:

.. literalinclude:: ./source/objectlijstpersoon-order-response.json

.. 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.



















Objectlijst Rechthebbende
^^^^^^^^^^^^^^^^^^^^^^^^^

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