Dossier Collection
==================

This collection provides functionality to create dossiers via the AccelerateConnect API.

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

.. _dossier-createFromDossierRequest:

New dossier (createFromDossierRequest)
--------------------------------------

``POST /dossier/createFromDossierRequest``

This endpoint allows you to create a new dossier with max 2 consumers.
The dossier-requests exist out of a set of required fields, extended with consumer (person) 
related fields.

.. note:: The provided advisor within this call will also be the dossier advisor.


Request
.......

+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Parameter           | Type                            | Required | Description                                                              |
+=====================+=================================+==========+==========================================================================+
| Dossier             | DossierProperty                 | Yes      | Main node of this request (see below)                                    |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+


DossierProperty
...............

+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Parameter           | Type                            | Required | Description                                                              |
+=====================+=================================+==========+==========================================================================+
| ExternalID          | string                          | No       | Your identification number for this dossier                              |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| ProjectId           | string                          | No       | Project code of a project defined in Accelerate                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| LeadSourceId        | string                          | No       | The code of a leadsource defined in Accelerate                           |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| AdvisorId           | string                          | No       | The advisor (employee) code defined in user management                   |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| OwnerId             | string                          | No       | The dossier owner (employee) code defined in user management             |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| LocationId          | string                          | No       | The code of a location defined in Accelerate                             |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| CampaignId          | string                          | No       | The code of a campaign defined in Accelerate                             |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| ProductPhaseId      | string                          | No       | The code of a product-phase defined in Accelerate                        |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Persons             | array                           | Yes      | Holds min. 1 (max 2) PersonProperty nodes (see below)                    |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+


PersonProperty
..............

+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Parameter           | Type                            | Required | Description                                                              |
+=====================+=================================+==========+==========================================================================+
| ExternalID          | string                          | No       | Your identification number for this person                               |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| AdressStyle         | enum('Formal', 'Informal')      | Yes      | Address-style for this person, applied on consumerportal, e-mails etc.   |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Street              | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Housenumber         | integer                         | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| HousenumberAddition | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Zipcode             | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| City                | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Country             | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| DateOfBirth         | date                            | Yes      |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Gender              | enum('MALE', 'FEMALE')          | Yes      |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Initials            | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| FirstName           | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Preposition         | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| Emailaddress        | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| PhoneMobile         | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| PhoneHome           | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| PhoneWork           | string                          | No       |                                                                          |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| IncomeTypeID        | string                          | No       | The code of an income-type defined in Accelerate                         |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+
| ConsumerProfileId   | string                          | No       | The code of a consumer-profile defined in Accelerate                     |
+---------------------+---------------------------------+----------+--------------------------------------------------------------------------+

Example request
...............

.. code-block:: json
  :linenos:

  { 
    "Dossier": { 
      "ExternalID": "DOSSIER-1569505160.8884",
      "Persons": [ 
        { 
          "ExternalID": null,
          "AdressStyle": "Formal",
          "Street": "Testlaan",
          "Housenumber": 10,
          "HousenumberAddition": "A",
          "Zipcode": "1000AA",
          "City": "Amsterdam",
          "Country": "Nederland",
          "DateOfBirth": "2000-10-22",
          "Gender": "MALE",
          "Initials": "J",
          "FirstName": "Jan",
          "Preposition": "in het",
          "Surname": "Veld",
          "Emailaddress": "jan@hdconnect.nl",
          "PhoneMobile": "0612341234",
          "PhoneHome": "0570665140",
          "PhoneWork": "0570665144"
        },
        { 
          "ExternalID": null,
          "AdressStyle": "Formal",
          "Street": "Testlaan",
          "Housenumber": 200,
          "HousenumberAddition": "A",
          "Zipcode": "1000AA",
          "City": "Amsterdam",
          "Country": "Nederland",
          "DateOfBirth": "1999-11-24",
          "Gender": "FEMALE",
          "Initials": "D",
          "FirstName": "Dorien",
          "Preposition": "",
          "Surname": "Langehals",
          "Emailaddress": "dorien@hdconnect.nl",
          "PhoneMobile": "0612345678",
          "PhoneHome": null,
          "PhoneWork": null
        }
      ]
    }
  }

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

Response
........

.. code-block:: json
  :linenos:

  {
    "dossier_id": "DS123456789AAA",
    "persons": [
      "CNSR123456789AAA",
      "CNSR123456789BBB"
    ]
  }

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

Errors
......

Here follows a list of errors that can occur while calling this endpoint.

+-------------------------------------------+-------------------------------------------------------------+
| Type                                      | Explanation                                                 |
+===========================================+=============================================================+
| NODE_MISSING                              | Dossier or Persons node not provided in payload             |
+-------------------------------------------+-------------------------------------------------------------+
| OUT_OF_INDEX                              | Provided amount of persons must be at least 1, max 2        |
+-------------------------------------------+-------------------------------------------------------------+
| DOSSIER_EXTERNAL_ID_EXISTS                | A dossier with the provided external ID already exists      |
+-------------------------------------------+-------------------------------------------------------------+
| PERSON_EXTERNAL_ID_EXISTS                 | A person with the provided external ID already exists       |
+-------------------------------------------+-------------------------------------------------------------+
| PERSON_GENDER_INVALID                     | Provided gender is not valid (see enum values)              |
+-------------------------------------------+-------------------------------------------------------------+
| PERSON_DOB_INVALID                        | Invalid date of birth provided                              |
+-------------------------------------------+-------------------------------------------------------------+
| INCOME_TYPE_NOT_FOUND                     | The provided IncomeTypeID is not defined in Accelerate      |
+-------------------------------------------+-------------------------------------------------------------+
| CONSUMER_PROFILE_NOT_FOUND                | The provided ConsumerProfileId is not defined in Accelerate |
+-------------------------------------------+-------------------------------------------------------------+
| PROJECT_NOT_FOUND                         | The provided ProjectId is not defined in Accelerate         |
+-------------------------------------------+-------------------------------------------------------------+
| LEADSOURCE_NOT_FOUND                      | The provided LeadSourceId is not defined in Accelerate      |
+-------------------------------------------+-------------------------------------------------------------+
| CAMPAIGN_NOT_FOUND                        | The provided CampaignId is not defined in Accelerate        |
+-------------------------------------------+-------------------------------------------------------------+
| ADVISOR_NOT_FOUND                         | The provided AdvisorId is not defined in Accelerate         |
+-------------------------------------------+-------------------------------------------------------------+
| PRODUCT_PHASE_NOT_FOUND                   | The provided ProductPhaseId is not defined in Accelerate    |
+-------------------------------------------+-------------------------------------------------------------+
| LOCATION_NOT_FOUND                        | The provided LocationId is not defined in Accelerate        |
+-------------------------------------------+-------------------------------------------------------------+