[ARCHIVE] Conditions for returning data from the CommonSimpleAddress and CommonPAFAddress schemas

Archived 2022-10-11. Content moved to CDS Guide, Data formats - schemas.

The following questions are rules for a Data Holder around returning data from the CommonSimpleAddress and CommonPAFAddress schemas.

Question

Is the below rule correct?

If the requested addressUType = "simple", return all the mandatory data from the CommonSimpleAddress schema.

If the requested addressUType = "paf", return all the mandatory data from the CommonPAFAddress schema.

Answer

Yes. You must provide all other optional data if you also hold that for the address.

Question

There are three fields defined as mandatory in theCommonPAFAddress schema: localityName (suburb), postcode and state. If the requested addressUType = "paf", is it mandatory to return the data related to these three fields only, with the remaining (optional) fields empty?

Answer

No. You must return all fields in the CommonPAFAddress which you hold for the customer or organisation. If you do not hold all mandatory fields, then the address is not valid and you could not return the address record. For optional fields and treatment of empty state, please see response below.

Questions

If the requestedaddressUType = "paf", can the data returned be an empty string?

Answer

For optional fields, an empty string is not valid. You may provide a null value for the optional field or exclude the field entirely in the response if you do not hold a value.

The handling of mandatory and optional fields is described in CDS Payload Conventions.