FetchDossiersData

Full path FetchDossiersData?ClientID={ClientID}&BatchId={BatchId}&FormId={FormId}&Name={Name}&StatusId={StatusId}&DateFrom={DateFrom}&DateTo={DateTo}&Reference={Reference}&HiddenStatusses={HiddenStatusses}
HTTP Verb GET
Description This endpoint expects an HTTP GET request with a ClientID and filter parameters.
Requires authentication with an OAuth2 token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientID

The unique client id

string

Required

BatchId

filter

integer

None.

FormId

filter

string

None.

Name

filter

string

None.

StatusId

filter

integer

None.

DateFrom

filter in format yyyyMMdd

string

None.

DateTo

filter in format yyyyMMdd

string

None.

Reference

filter

string

None.

HiddenStatusses

do not return record with one of these statusses, sepearated by a ,

string

None.

Body Parameters

None.

Response Information

Resource Description

a list of dossiers (with formdata and files) available for this ClientID, filtered by the other parameters

Collection of DossierExtended
NameDescriptionTypeAdditional information
Data

The data of a filled in dossier

Object

None.

Files

Collection of File

None.

AriadNextData

Object

None.

AriadNextChecks

Object

None.

AriadNextIssuance

Object

None.

AriadNextInfo

Object

None.

IDQualityIssues

Object

None.

ActivityLogs

Collection of Log

None.

Id

The unique identifier for a dossier

integer

None.

BatchId

The unique identifier for a batch

integer

None.

BatchName

The name of the batch

string

None.

Name

The name of the dossier

string

None.

Email

The email address of the dossier

string

None.

Language

The language of a dossier in Alpha2 (e.g. EN, FR, NL)

string

None.

Country

The language of a dossier in Alpha2 (e.g. GB, FR, NL)

string

None.

FormId

The unique identifier for a form

string

None.

Code

The unique code to be used in the URL

string

None.

StatusId

The status id of a dossier

integer

None.

StatusDescription

The status description of a batch

string

None.

LastChange

The last change date and time of a dossier

date

None.

StartDate

The start date and time of a dossier

date

None.

Contact

The contact first and last name

string

None.

Reference

The internal reference of the dossier

string

None.

Duns

The DUNS of the dossier

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Data": {},
    "Files": [
      {
        "Id": "sample string 1",
        "Field": "sample string 2",
        "ValidationStatus": 3,
        "MetaData": "sample string 4",
        "AriadnextData": "sample string 5"
      },
      {
        "Id": "sample string 1",
        "Field": "sample string 2",
        "ValidationStatus": 3,
        "MetaData": "sample string 4",
        "AriadnextData": "sample string 5"
      }
    ],
    "AriadNextData": {},
    "AriadNextChecks": {},
    "AriadNextIssuance": {},
    "AriadNextInfo": {},
    "IDQualityIssues": {},
    "ActivityLogs": [
      {
        "Timestamp": "sample string 1",
        "Action": "sample string 2",
        "ActionID": 3,
        "Comment": "sample string 4",
        "User_type": "sample string 5",
        "User_id": 6
      },
      {
        "Timestamp": "sample string 1",
        "Action": "sample string 2",
        "ActionID": 3,
        "Comment": "sample string 4",
        "User_type": "sample string 5",
        "User_id": 6
      }
    ],
    "Id": 7,
    "BatchId": 8,
    "BatchName": "sample string 9",
    "Name": "sample string 10",
    "Email": "sample string 11",
    "Language": "sample string 12",
    "Country": "sample string 13",
    "FormId": "sample string 14",
    "Code": "sample string 15",
    "StatusId": 16,
    "StatusDescription": "sample string 17",
    "LastChange": "2026-03-24T22:52:41.5522173+01:00",
    "StartDate": "2026-03-24T22:52:41.5522173+01:00",
    "Contact": "sample string 20",
    "Reference": "sample string 21",
    "Duns": "sample string 22"
  },
  {
    "Data": {},
    "Files": [
      {
        "Id": "sample string 1",
        "Field": "sample string 2",
        "ValidationStatus": 3,
        "MetaData": "sample string 4",
        "AriadnextData": "sample string 5"
      },
      {
        "Id": "sample string 1",
        "Field": "sample string 2",
        "ValidationStatus": 3,
        "MetaData": "sample string 4",
        "AriadnextData": "sample string 5"
      }
    ],
    "AriadNextData": {},
    "AriadNextChecks": {},
    "AriadNextIssuance": {},
    "AriadNextInfo": {},
    "IDQualityIssues": {},
    "ActivityLogs": [
      {
        "Timestamp": "sample string 1",
        "Action": "sample string 2",
        "ActionID": 3,
        "Comment": "sample string 4",
        "User_type": "sample string 5",
        "User_id": 6
      },
      {
        "Timestamp": "sample string 1",
        "Action": "sample string 2",
        "ActionID": 3,
        "Comment": "sample string 4",
        "User_type": "sample string 5",
        "User_id": 6
      }
    ],
    "Id": 7,
    "BatchId": 8,
    "BatchName": "sample string 9",
    "Name": "sample string 10",
    "Email": "sample string 11",
    "Language": "sample string 12",
    "Country": "sample string 13",
    "FormId": "sample string 14",
    "Code": "sample string 15",
    "StatusId": 16,
    "StatusDescription": "sample string 17",
    "LastChange": "2026-03-24T22:52:41.5522173+01:00",
    "StartDate": "2026-03-24T22:52:41.5522173+01:00",
    "Contact": "sample string 20",
    "Reference": "sample string 21",
    "Duns": "sample string 22"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDossierExtended xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <DossierExtended>
    <BatchId>8</BatchId>
    <BatchName>sample string 9</BatchName>
    <Code>sample string 15</Code>
    <Contact>sample string 20</Contact>
    <Country>sample string 13</Country>
    <Duns>sample string 22</Duns>
    <Email>sample string 11</Email>
    <FormId>sample string 14</FormId>
    <Id>7</Id>
    <Language>sample string 12</Language>
    <LastChange>2026-03-24T22:52:41.5522173+01:00</LastChange>
    <Name>sample string 10</Name>
    <Reference>sample string 21</Reference>
    <StartDate>2026-03-24T22:52:41.5522173+01:00</StartDate>
    <StatusDescription>sample string 17</StatusDescription>
    <StatusId>16</StatusId>
    <ActivityLogs>
      <Log>
        <Action>sample string 2</Action>
        <ActionID>3</ActionID>
        <Comment>sample string 4</Comment>
        <Timestamp>sample string 1</Timestamp>
        <User_id>6</User_id>
        <User_type>sample string 5</User_type>
      </Log>
      <Log>
        <Action>sample string 2</Action>
        <ActionID>3</ActionID>
        <Comment>sample string 4</Comment>
        <Timestamp>sample string 1</Timestamp>
        <User_id>6</User_id>
        <User_type>sample string 5</User_type>
      </Log>
    </ActivityLogs>
    <AriadNextChecks />
    <AriadNextData />
    <AriadNextInfo />
    <AriadNextIssuance />
    <Data />
    <Files>
      <File>
        <AriadnextData>sample string 5</AriadnextData>
        <Field>sample string 2</Field>
        <Id>sample string 1</Id>
        <MetaData>sample string 4</MetaData>
        <ValidationStatus>3</ValidationStatus>
      </File>
      <File>
        <AriadnextData>sample string 5</AriadnextData>
        <Field>sample string 2</Field>
        <Id>sample string 1</Id>
        <MetaData>sample string 4</MetaData>
        <ValidationStatus>3</ValidationStatus>
      </File>
    </Files>
    <IDQualityIssues />
  </DossierExtended>
  <DossierExtended>
    <BatchId>8</BatchId>
    <BatchName>sample string 9</BatchName>
    <Code>sample string 15</Code>
    <Contact>sample string 20</Contact>
    <Country>sample string 13</Country>
    <Duns>sample string 22</Duns>
    <Email>sample string 11</Email>
    <FormId>sample string 14</FormId>
    <Id>7</Id>
    <Language>sample string 12</Language>
    <LastChange>2026-03-24T22:52:41.5522173+01:00</LastChange>
    <Name>sample string 10</Name>
    <Reference>sample string 21</Reference>
    <StartDate>2026-03-24T22:52:41.5522173+01:00</StartDate>
    <StatusDescription>sample string 17</StatusDescription>
    <StatusId>16</StatusId>
    <ActivityLogs>
      <Log>
        <Action>sample string 2</Action>
        <ActionID>3</ActionID>
        <Comment>sample string 4</Comment>
        <Timestamp>sample string 1</Timestamp>
        <User_id>6</User_id>
        <User_type>sample string 5</User_type>
      </Log>
      <Log>
        <Action>sample string 2</Action>
        <ActionID>3</ActionID>
        <Comment>sample string 4</Comment>
        <Timestamp>sample string 1</Timestamp>
        <User_id>6</User_id>
        <User_type>sample string 5</User_type>
      </Log>
    </ActivityLogs>
    <AriadNextChecks />
    <AriadNextData />
    <AriadNextInfo />
    <AriadNextIssuance />
    <Data />
    <Files>
      <File>
        <AriadnextData>sample string 5</AriadnextData>
        <Field>sample string 2</Field>
        <Id>sample string 1</Id>
        <MetaData>sample string 4</MetaData>
        <ValidationStatus>3</ValidationStatus>
      </File>
      <File>
        <AriadnextData>sample string 5</AriadnextData>
        <Field>sample string 2</Field>
        <Id>sample string 1</Id>
        <MetaData>sample string 4</MetaData>
        <ValidationStatus>3</ValidationStatus>
      </File>
    </Files>
    <IDQualityIssues />
  </DossierExtended>
</ArrayOfDossierExtended>