Read customers cards

You use this method to read one or more customer cards.

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/Customer?{Key}={KeyValues}[&fields={FieldList}]

Context identification

Identification Description
DossierId The unique identifier of the dossier.

Parameters

Parameter Description
{Key} The available keys to seek one or more customers:
  • SystemNumber={SystemNumber}: Seek customer cards by system number.
  • NumberPair={Number}<tab>{SubNumber}: Seek customer cards by number and subnumber.
  • SyncReference={SyncReference}: Seek customer cards by synchronization reference.
Fields

List of fields, containing property names of the customer card, of which the value has to be returned in the response body. (optional)

Remark: If this list contains invalid field names an exception will be thrown.
Example: Get the customer card with number '2' and subnumber '1' from dossier 'Demo' and limit the data to the following fields: 'Name', 'PostalCode' and 'City'. 
https://ponte.venice.be/WebConnect/api/Demo/Customer?NumberPair=2%091&fields=Name,PostalCode,City

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)

Examples

{
  "Response": {
    "Customers": {
      "Customer": [
        {
          "Fields" : {
            "Name": "My customer NV",
            "PostalCode": "8200",
            "City": "Brugge"
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Customers>
    <Customer>
      <Fields>
        <Name>My customer NV</Name>
        <PostalCode>8200</PostalCode>
        <City>Brugge</City>
      </Fields>
    </Customer>
  </Customers>
</Response>