au.org.consumerdatastandards.api.common.models.CommonPersonDetail 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 java.util.List;
import au.org.consumerdatastandards.support.data.*;

@DataDefinition(
    allOf = { CommonPerson.class }
)
public class CommonPersonDetail {

    @Property(
        description = "Array is mandatory but may be empty if no phone numbers are held",
        required = true
    )
    List phoneNumbers;

    @Property(
        description = "May be empty",
        required = true
    )
    List emailAddresses;

    @Property(
        description = "Must contain at least one address. One and only one address may have the purpose of REGISTERED. Zero or one, and no more than one, record may have the purpose of MAIL. If zero then the REGISTERED address is to be used for mail",
        required = true
    )
    List physicalAddresses;
}