au.org.consumerdatastandards.api.common.models.CommonSimpleAddress Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-model Show documentation

This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

There is a newer version: 1.1.1

Show newest version

package au.org.consumerdatastandards.api.common.models;

import au.org.consumerdatastandards.support.data.*;

@DataDefinition
@CustomAttributes({
    @CustomAttribute(name = "x-conditional", value = "postcode", multiple = true)
})
public class CommonSimpleAddress {

    @Property(
        description = "Name of the individual or business formatted for inclusion in an address used for physical mail"
    )
    String mailingName;

    @Property(
        description = "First line of the standard address object",
        required = true
    )
    String addressLine1;

    @Property(
        description = "Second line of the standard address object"
    )
    String addressLine2;

    @Property(
        description = "Third line of the standard address object"
    )
    String addressLine3;

    @Property(
        description = "Mandatory for Australian addresses"
    )
    String postcode;

    @Property(
        description = "Name of the city or locality",
        required = true
    )
    String city;

    @Property(
        description = "Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [ISO 3166:AU standard](https://www.iso.org/obp/ui/#iso:code:3166:AU)",
        required = true
    )
    String state;

    @Property(
        description = "A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code"
    )
    @CDSDataType(CustomDataType.ExternalRef)
    String country;
}