Read postal code cards

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

Request method

GET

Request url

https://venice.unit4.com/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.
  • PostalCode={PostalCode}: Seek postal code cards by postal code.
  • City={City}: Seek postal code cards by city.
  • PostalCodePair={PostalCode}<tab>{City}: Seek postal code cards by postal code and city.
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 from dossier 'Demo' a postal code card with city 'Brugge' and limit the data to the following fields: 'PostalCode' and 'City'.
https://venice.unit4.com/WebConnect/api/Demo/PostalCode?City=Brugge&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>