Dossier

Full path	Dossier
HTTP Verb	POST
Description	This endpoint expects an HTTP POST request with the relevant information in Json format. It creates a dossier for one client and adds it to the workflow. Requires authentication with an OAuth2 token

Request Information

URI Parameters

None.

Body Parameters

DossierImportModel

Name	Type	Additional information
duns	string	None.
country	string	None.
language	string	None.
name	string	None.
prefill_values	Object	None.
form_id	string	None.
client_id	string	None.
customer_client_id	string	None.
contacts	Collection of Contact	None.
email_content	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"
}

application/xml, text/xml

Sample:

<DossierImportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

"success" or an error

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.