PostalAddress

A postal address in any country.

Use it for where to send a parcel or a letter. It fits every country, since locality, region and postal code are only there when the country uses them. A point on a map is a Point, and a property's own number in Great Britain is a Uprn. It is personal data with no personal: on the field: it counts as PersonalData.contact.

Shape

Write every field when you build one, and give a field that isn't required as none.

Its parts keep these rules, and a value that breaks one fails with the rule's name:

• postal_code_of_country: postal_code is in the form of its country's postal codes

Example

PostalAddress {    lines: ["Buckingham Palace"]    locality: "London"    region: none    postal_code: "SW1A 1AA"    country: Country.gb}

Good to know

• text.format writes it the way its country lays out an address, and leaves the country line out for a reader in the same country.
• The postal code is checked against the country's own form, so a value with a French code and Country.gb is refused.
• == tells you whether two are the same. < and list.sort_by don't take it, so sort by one of its parts instead.
• A field that holds one counts as personal data (contact), so you don't mark it yourself.

In JSON

An object of its parts, in a request, a response or json.write:

{"lines":["Buckingham Palace"],"locality":"London","region":null,"postal_code":"SW1A 1AA","country":"GB"}{"lines":["2-7-2 Marunouchi"],"locality":"Chiyoda-ku","region":"Tokyo","postal_code":"100-8994","country":"JP"}

When you read one, a field that isn't required may be left out, or sent as null.

Details