Reference
This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.
- Quick reminder:
-
- Representation: a set of name-value pairs representing the state of a resource.
- Relation: the identifier of a link between two resources.
postal-addresses
postal-address-representation
Description: A representation of a postal address resource. A postal address identifies a geographical location.
Properties
- street1
- The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. Constraints: Text, 70 characters or less, Read-Write.
- street2
- The second line of the street address. Constraints: Text, 70 characters or less, Read-Write (optional).
- city
- The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
- postalCode
- The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
- country
- The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.