Read Venice information

You use this method to read information of a Venice installation.

Request method

GET

Request url

https://venice.unit4.com/webconnect/api/Venice[/{InformationType}]

Context identification

Identification Description
InformationType Requests a specific type of information. Possible values:
  • DossierList:

    Gets a list of all dossiers available through WebConnect.

Example 1: Get general information of the Venice installation.
https://venice.unit4.com/WebConnect/api/Venice
Example 2: Get a list of all the dossiers in the Venice installation that can be accessed through WebConnect.
https://venice.unit4.com/WebConnect/api/Venice/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

The structure of the response body depends on the value of the parameter 'informationType'. Parameter 'informationType' is not provided
Response (object)
Parameter 'informationType' has the value 'DossierList'
Response (object)
  • Venice (object)
    • Dossiers (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": {
    "Venice": {
      "VeniceVersion": "10.10_",
      "Registration": {
        "Number": "1234567890",
        "Type": "9;50;500;31/01/2016;none"
      },
      "User": {
        "Function": "Tester",
        "Groups": "",
        "Initials": "WCO",
        "Name": "WebConnect"
      },
      "LogonIdentification": "MyId"
    }
  }
}
{
  "Response": {
    "Venice": {
      "Dossiers": {
        "Dossier": [
          {
            "Identification": "DemoDdf",
            "Name": "Demo",
            "FirmName": "Demo Dossier ODBC",
            "Cabinet": {
              "Identification": "1",
              "Name": "Standaard dossierkast"
            }
          }
        ]
      }
    }
  }
}
<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Venice>
    <VeniceVersion>10.10_</VeniceVersion>
    <Registration>
      <Number>1234567890</Number>
      <Type>9;50;500;31/01/2016;none</Type>
    </Registration>
    <User>
      <Function>Tester</Function>
      <Groups />
      <Initials>WCO</Initials>
      <Name>WebConnect</Name>
    </User>
    <LogonIdentification>MyId</LogonIdentification>
  </Venice>
</Response>
<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Venice>
    <Dossiers>
      <Dossier>
        <Identification>DemoDdf</Identification>
        <Name>Demo</Name>
        <FirmName>Demo Dossier ODBC</FirmName>
        <Cabinet>
          <Identification>1</Identification>
          <Name>Standaard dossierkast</Name>
        </Cabinet>
      </Dossier>
    </Dossiers>
  </Venice>
</Response>