Get dossier list

You use this method to get the list of dossiers the authenticated user has access to via WebConnect.

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/DossierList
Example: Get a list of all the dossiers in the Venice installation that can be accessed through WebConnect. 
https://ponte.venice.be/WebConnect/api/DossierList

Request header

See request header.

Request body

-

Http status

See http status.

Response body

You can receive the response in json or xml.

Structure

Response (object)
  • DossierList (array)
    • Dossier (array item)
      • Identification: Unique dossier identifier, that can be used for dossier related requests
      • Name: Name of the dossier (visible in the main menu of Venice)
      • FirmName: Name of the firm
      • Cabinet identification: Unique dossier cabinet identifier (can f.i. be used to group all dossiers belonging to the same dossier cabinet)
      • Cabinet name: Name of the dossier cabinet (visible in the main menu of Venice)

Examples

{
  "Response": {
    "DossierList": {
      "Dossier": [
        {
          "Identification": "DemoDdf",
          "Name": "Demo",
          "FirmName": "Demo Dossier ODBC",
          "IsLocked": "False",
          "Cabinet": {
            "Identification": "1",
            "Name": "Standaard dossierkast"
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <DossierList>
    <Dossier>
      <Identification>DemoDdf</Identification>
      <Name>Demo</Name>
      <FirmName>Demo Dossier ODBC</FirmName>
      <IsLocked>False</IsLocked>
      <Cabinet>
        <Identification>1</Identification>
        <Name>Standaard dossierkast</Name>
      </Cabinet>
    </Dossier>
  </DossierList>
</Response>