Read postal code cards

You use this method to read one or more postal code cards.

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/PostalCode?{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 postal codes:
  • SystemNumber={SystemNumber}: Seek postal code cards by system number.
Fields List of fields, containing property names of the postal code card, of which the value has to be returned in the response body. (optional)
Example: Get the postal code card with system number '2449' from dossier 'Demo' and limit the data to the following fields: 'PostalCode' and 'City'. 
https://ponte.venice.be/WebConnect/api/Demo/PostalCode?SystemNumber=2449&fields=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": {
    "PostalCodes": {
      "PostalCode": [
        {
          "Fields" : {
            "PostalCode": "8000",
            "City": "Brugge"
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <PostalCodes>
    <PostalCode>
      <Fields>
        <PostalCode>8000</PostalCode>
        <City>Brugge</City>
      </Fields>
    </PostalCode>
  </PostalCodes>
</Response>