REST Auth API: Addresses

Address resources are a subresource of Contacts, Organisations and Venues, and describe a physical or postal address for the related resource.

Address instance resource

Resource URIs

/api/2012-02-01/auth/resources/contacts/{ContactID}/postaladdress/

/api/2012-02-01/auth/resources/organisations/{OrganisationID}/postaladdress/

/api/2012-02-01/auth/resources/organisations/{OrganisationID}/physicaladdress/

/api/2012-02-01/auth/resources/venues/{VenueID}/physicaladdress/

Resource properties

Property	Description
StreetLine1	A string describing street line 1 of the address, up to 256 characters long.
StreetLine2	A string describing street line 2 of the address, up to 256 characters long.
StreetLine3	A string describing street line 3 of the address, up to 256 characters long.
StreetLine4	A string describing street line 4 of the address, up to 256 characters long.
SuburbOrRegion	A string describing the suburb or region of the address, up to 256 characters long.
City	A string describing the city of the address, up to 128 characters long.
StateOrProvince	A string describing the state/province of the address, up to 128 characters long.
PostCode	A string describing the postcode of the address, up to 16 characters long.
Country	A string describing the country of the address, up to 128 characters long.

HTTP GET

Returns a representation of an Address, including the properties above.

Example

GET /api/2012-02-01/auth/resources/organisations/562/postaladdress/

<Address>
  <StreetLine1>Level 1</StreetLine1>
  <StreetLine2>Acme Tower</StreetLine2>
  <StreetLine3>98 Wallacetown Quay</StreetLine3>
  <StreetLine4>PO Box 98442</StreetLine4>
  <SuburbOrRegion>Northcote</SuburbOrRegion>
  <City>Metropolis</City>
  <PostCode>9332</PostCode>
  <Country>New Zealand</Country>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisations/562/postaladdress/"/>
</Address>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.