Consumerportal Collection
=========================

The consumerportal collection has a set of endpoints which provide all neccesary information about the consumers' dossier. This also includes information about their products and productactions.

-------------------------

getSession
----------

``GET /consumerportal/getsession``

This endpoint returns all the information about the consumers dossier.


Request
.......

This request require these parameters:

+--------------+--------+-----------+---------------------------------------------+
| Parameter    | Type   | Required  | Description                                 |
+==============+========+===========+=============================================+
| consumer_id  | string |  ``Yes``  | Consumer id                                 |
+--------------+--------+-----------+---------------------------------------------+
| ip_address   | string |  ``Yes``  | IP address of the consumer using the portal |
+--------------+--------+-----------+---------------------------------------------+

Response
........

.. code-block:: json
  :linenos:

  {
    "consumerportalsession": {
      "session": {
        "date_started": "2018-01-01 12:00:00",
        "session_id": "ok1t1s26ecft711b72tlkjoae0",
        "state": "RUNNING"
      },
      "dossier": {
        "id": "DS86CE093EB31D131449DCABEBB7C39F",
        "code": "TEST-1",
        "date_created": "2018-01-01",
        "owner": {
          "name": "Testgebruiker",
          "phone": "0570 665 144",
          "emailaddress": "sample@bwss.nl",
          "avatar_base64": null
        },
        "advisor": {
          "name": "Testgebruiker",
          "phone": "0570 665 144",
          "emailaddress": "sample@bwss.nl",
          "avatar_base64": null
        },
        "products": {
          "PRFE1A72620E23AC13009D2287C6B864": {
            "id": "PRFE1A72620E23AC13009D2287C6B864",
            "type": "MORTGAGE",
            "label": "SNS Budget Hypotheek",
            "reference_number": "TEST-1-M-ea66c06c1e1c05fa9f1aa39d98dc5bc1",
            "quote_number": "",
            "mortgage": {
              "label": "SNS Budget Hypotheek",
              "arrangement": null,
              "mortgage_amount": null,
              "lender_name": "SNS Bank",
              "has_timeline": true,
              "rendered_timeline": "<div class=\"container-fluid\"></div>"
            },
            "productaction_counters": {
              "total": 1,
              "done": 1
            },
            "productactions": {
              "PRA433FB8570F2C0F6D816F1A0A283BFE": {
                "id": "PRA433FB8570F2C0F6D816F1A0A283BFE",
                "date_created": "2018-01-01",
                "date_executed": "2018-01-01",
                "is_done": 1,
                "type": "UPLOAD_DOCUMENTMANAGEMENT_FILE",
                "comment": "",
                "label": "Aanleveren van geldig legitimatiebewijs (Jan Janssen)",
                "product_id": "PRFE1A72620E23AC13009D2287C6B864",
                "document": {
                  "upload_requirements": [
                    "Paspoort opengevouwen met beide pagina's in beeld",
                    "Europese Identiteitskaart, kopie op ware grootte van de voor- en achterzijde."
                  ],
                  "label": "Geldig legitimatiebewijs (Paspoort of Europese Identiteitskaart)",
                  "description": "",
                  "is_consumer_specific": true,
                  "consumer_name": "Jan Janssen"
                }
              }
            }
          }
        },
        "consumer": {
          "id": "CNSR22966DC6C1D2E53D861B2794F6A20E",
          "gender": "M",
          "initials": null,
          "firstname": "Jan",
          "prefix": "",
          "surname": "Janssen",
          "display_name": "Jan Janssen",
          "streetname": "Herfordstraat",
          "housenumber": "8",
          "housenumber_addition": null,
          "date_of_birth": null,
          "zipcode": "7418EX",
          "city": "Deventer",
          "phone": "0570 665 144",
          "phone_mobile": null,
          "emailaddress": "j.janssen@freeler.nl"
        }
      },
      "duplicate_comfort_data": {
        "downloadable_productactions": [
        ],
        "uploadable_productactions": {
          "PRA433FB8570F2C0F6D816F1A0A283BFE": {
            "id": "PRA433FB8570F2C0F6D816F1A0A283BFE",
            "date_created": "2018-01-01",
            "date_executed": "2018-01-01",
            "is_done": 1,
            "type": "UPLOAD_DOCUMENTMANAGEMENT_FILE",
            "comment": "",
            "label": "Aanleveren van geldig legitimatiebewijs",
            "product_id": "PRFE1A72620E23AC13009D2287C6B864",
            "document": {
              "upload_requirements": [
                "Paspoort opengevouwen met beide pagina's in beeld",
                "Europese Identiteitskaart, kopie op ware grootte"
              ],
              "label": "Geldig legitimatiebewijs",
              "description": "",
              "is_consumer_specific": true,
              "consumer_name": "Jan Janssen"
            }
          }
        },
        "actioncounter_total": {
          "total": 1,
          "done": 1
        },
        "actioncounter_per_product": {
          "PRFE1A72620E23AC13009D2287C6B864": {
            "total": 1,
            "done": 1
          }
        },
        "most_recent_appointment": false,
        "productactions": {
          "PRA433FB8570F2C0F6D816F1A0A283BFE": {
            "id": "PRA433FB8570F2C0F6D816F1A0A283BFE",
            "date_created": "2018-01-01",
            "date_executed": "2018-01-01",
            "is_done": 1,
            "type": "UPLOAD_DOCUMENTMANAGEMENT_FILE",
            "comment": "",
            "label": "Aanleveren van geldig legitimatiebewijs (Jan Janssen)",
            "product_id": "PRFE1A72620E23AC13009D2287C6B864",
            "document": {
              "upload_requirements": [
                "Paspoort opengevouwen met beide pagina's in beeld",
                "Europese Identiteitskaart, kopie op ware grootte"
              ],
              "label": "Geldig legitimatiebewijs",
              "description": "",
              "is_consumer_specific": true,
              "consumer_name": "Jan Janssen"
            }
          }
        }
      }
    }
  }

-------------------------

getProductActionDownload
------------------------

``GET /consumerportal/get_product_action_download``

This endpoint will return a document associated with the product action.


Request
.......

+------------------+--------+-----------+-------------------------------------------------+
| Parameter        | Type   | Required  | Description                                     |
+==================+========+===========+=================================================+
| productaction_id | string |  ``Yes``  | Product action id (found in getSession request) |
+------------------+--------+-----------+-------------------------------------------------+


Response
........

.. code-block:: text
  :linenos:

  Content-Type: application/pdf
  Content-Length: 1024
  Content-Disposition: attachment; filename="demo.pdf"

  <file_blob>

-------------------------

uploadFile
-----------

``POST /consumerportal/upload_file``

With this endpoint you can upload a file to accelerate.


.. note:: This endpoint is an upload type, which means that parameters are sent as header,
  see :ref:`request_methods`
.. warning:: This request can be fired only once per product action or it needs to be a reupload


Request
.......

+-------------------+--------+-----------+-----------------------------------------------------------------+
| Parameter         | Type   | Required  | Description                                                     |
+===================+========+===========+=================================================================+
| productaction_id  | string |  ``Yes``  | For which product action is this file for                       |
+-------------------+--------+-----------+-----------------------------------------------------------------+
| is_reupload       | int(1) |  ``Yes``  | Whenever this action is a reupload or not (1 = True, 0 = False) |
+-------------------+--------+-----------+-----------------------------------------------------------------+
| filename          | string |  ``Yes``  | The filename of the uploaded file                               |
+-------------------+--------+-----------+-----------------------------------------------------------------+
| mimetype          | string |  ``Yes``  | The mimetype of the uploaded file                               |
+-------------------+--------+-----------+-----------------------------------------------------------------+
| comment           | string |  ``No``   | A comment placed by the consumer about the file                 |
+-------------------+--------+-----------+-----------------------------------------------------------------+

Response
........

.. code-block:: json
  :linenos:

  {
    "operation_result" : "ok"
  }

-------------------------

getOtdPdf
---------

``GET /consumerportal/get_otd_pdf``

Get the pdf of an OTD document.


Request
.......

+------------------+--------+-----------+-------------------------------------------------+
| Parameter        | Type   | Required  | Description                                     |
+==================+========+===========+=================================================+
| productaction_id | string |  ``Yes``  | Product action id (found in getSession request) |
+------------------+--------+-----------+-------------------------------------------------+


Response
........

.. code-block:: json
  :linenos:

  {
    "raw_pdf_data" : "<base64_encoded pdf blob>",
    "filename" : "otd.pdf"
  }

-------------------------

signOtd
-------

``POST /consumerportal/sign_otd``

Signs an OTD in name of the logged in consumer. This is a digital sign.

Request
.......

+------------------+--------+-----------+-------------------------------------------------+
| Parameter        | Type   | Required  | Description                                     |
+==================+========+===========+=================================================+
| productaction_id | string |  ``Yes``  | Product action id (found in getSession request) |
+------------------+--------+-----------+-------------------------------------------------+


Response
........

.. code-block:: json
  :linenos:

  {
    "operation_result" : "ok"
  }