Direct/BulkDossier

Full path	Direct/BulkDossier?BatchID={BatchID}
HTTP Verb	POST
Description	This endpoint expects an HTTP POST request with the relevant information in Json format. It creates a dossier for multiple clients without IndueD. Requires authentication with an OAuth2 token

Request Information

URI Parameters

Name	Description	Type	Additional information
BatchID		integer	None.

Body Parameters

Collection of DossierImportModel

Name	Description	Type	Additional information
duns	Required field with the DUNS number of a client	string	None.
country	Required field with a country code (BE, NL, FR, ...)	string	None.
language	Required field with a language code (BE, NL, FR, ...)	string	None.
name	Required field with the merchant's company name	string	None.
prefill_values	Optional field that contains a JSON like { field1: "value1", field2: "value2", … }	Object	None.
form_id	Required field with the ID of the form that was created with /CreateForm	string	None.
client_id	Required field with the client ID	string	None.
customer_client_id	Optional field with the client ID within the customer's system	string	None.
contacts	Required field with a list of contacts	Collection of Contact	None.
email_content	Optional field with a message to be added to the invitation email	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "duns": "sample string 1",
    "country": "sample string 2",
    "language": "sample string 3",
    "name": "sample string 4",
    "prefill_values": {},
    "form_id": "sample string 6",
    "client_id": "sample string 7",
    "customer_client_id": "sample string 8",
    "contacts": [
      {
        "email": "sample string 1",
        "phone": "sample string 2",
        "first_name": "sample string 3",
        "last_name": "sample string 4"
      },
      {
        "email": "sample string 1",
        "phone": "sample string 2",
        "first_name": "sample string 3",
        "last_name": "sample string 4"
      }
    ],
    "email_content": "sample string 9"
  },
  {
    "duns": "sample string 1",
    "country": "sample string 2",
    "language": "sample string 3",
    "name": "sample string 4",
    "prefill_values": {},
    "form_id": "sample string 6",
    "client_id": "sample string 7",
    "customer_client_id": "sample string 8",
    "contacts": [
      {
        "email": "sample string 1",
        "phone": "sample string 2",
        "first_name": "sample string 3",
        "last_name": "sample string 4"
      },
      {
        "email": "sample string 1",
        "phone": "sample string 2",
        "first_name": "sample string 3",
        "last_name": "sample string 4"
      }
    ],
    "email_content": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDossierImportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <DossierImportModel>
    <client_id>sample string 7</client_id>
    <contacts>
      <Contact>
        <email>sample string 1</email>
        <first_name>sample string 3</first_name>
        <last_name>sample string 4</last_name>
        <phone>sample string 2</phone>
      </Contact>
      <Contact>
        <email>sample string 1</email>
        <first_name>sample string 3</first_name>
        <last_name>sample string 4</last_name>
        <phone>sample string 2</phone>
      </Contact>
    </contacts>
    <country>sample string 2</country>
    <customer_client_id>sample string 8</customer_client_id>
    <duns>sample string 1</duns>
    <email_content>sample string 9</email_content>
    <form_id>sample string 6</form_id>
    <language>sample string 3</language>
    <name>sample string 4</name>
    <prefill_values />
  </DossierImportModel>
  <DossierImportModel>
    <client_id>sample string 7</client_id>
    <contacts>
      <Contact>
        <email>sample string 1</email>
        <first_name>sample string 3</first_name>
        <last_name>sample string 4</last_name>
        <phone>sample string 2</phone>
      </Contact>
      <Contact>
        <email>sample string 1</email>
        <first_name>sample string 3</first_name>
        <last_name>sample string 4</last_name>
        <phone>sample string 2</phone>
      </Contact>
    </contacts>
    <country>sample string 2</country>
    <customer_client_id>sample string 8</customer_client_id>
    <duns>sample string 1</duns>
    <email_content>sample string 9</email_content>
    <form_id>sample string 6</form_id>
    <language>sample string 3</language>
    <name>sample string 4</name>
    <prefill_values />
  </DossierImportModel>
</ArrayOfDossierImportModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

an list of errors

BulkResultModel

Name	Description	Type	Additional information
Status		string	None.
Errors		Collection of BulkError	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Errors": [
    {
      "Name": "sample string 1",
      "Email": "sample string 2",
      "Type": "sample string 3",
      "Message": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Email": "sample string 2",
      "Type": "sample string 3",
      "Message": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<BulkResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <Errors>
    <BulkError>
      <Email>sample string 2</Email>
      <Message>sample string 4</Message>
      <Name>sample string 1</Name>
      <Type>sample string 3</Type>
    </BulkError>
    <BulkError>
      <Email>sample string 2</Email>
      <Message>sample string 4</Message>
      <Name>sample string 1</Name>
      <Type>sample string 3</Type>
    </BulkError>
  </Errors>
  <Status>sample string 1</Status>
</BulkResultModel>