GET v1/ProfilePersons/{id}/ProfileAddresses?sort={sort}

Get Profile Person All Addresses

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required
sort

A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign.

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of GetProfilePersonAllAddressesOutput
NameDescriptionTypeAdditional information
id

The id of this address

 integer

None.
name

The name of this address

 string

None.
line1

The addressLine1 of this address

 string

None.
line2

The addressLine2 of this address

 string

None.
city

The city of this address

 string

None.
stateProvince

The state province of this address

 string

None.
postalCode

The postal code of this address

 string

None.
country

The country of this address

 string

None.
isPreferredBillingAddress

The value indicate if profile address is preferred billing address

 boolean

None.
isPreferredShippingAddress

The value indicate if profile address is preferred shipping address

 boolean

None.
isPreferredMailingAddress

The value indicate if profile address is preferred mailing address

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "name": "sample string 2",
    "line1": "sample string 3",
    "line2": "sample string 4",
    "city": "sample string 5",
    "stateProvince": "sample string 6",
    "postalCode": "sample string 7",
    "country": "sample string 8",
    "isPreferredBillingAddress": true,
    "isPreferredShippingAddress": true,
    "isPreferredMailingAddress": true
  },
  {
    "id": 1,
    "name": "sample string 2",
    "line1": "sample string 3",
    "line2": "sample string 4",
    "city": "sample string 5",
    "stateProvince": "sample string 6",
    "postalCode": "sample string 7",
    "country": "sample string 8",
    "isPreferredBillingAddress": true,
    "isPreferredShippingAddress": true,
    "isPreferredMailingAddress": true
  }
]

text/html

Sample: 
[{"id":1,"name":"sample string 2","line1":"sample string 3","line2":"sample string 4","city":"sample string 5","stateProvince":"sample string 6","postalCode":"sample string 7","country":"sample string 8","isPreferredBillingAddress":true,"isPreferredShippingAddress":true,"isPreferredMailingAddress":true},{"id":1,"name":"sample string 2","line1":"sample string 3","line2":"sample string 4","city":"sample string 5","stateProvince":"sample string 6","postalCode":"sample string 7","country":"sample string 8","isPreferredBillingAddress":true,"isPreferredShippingAddress":true,"isPreferredMailingAddress":true}]

application/xml, text/xml

Sample: 
<ArrayOfv1_ProfilePersons_ProfilePersonEndpointController.GetProfilePersonAllAddressesOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <v1_ProfilePersons_ProfilePersonEndpointController.GetProfilePersonAllAddressesOutput>
    <city>sample string 5</city>
    <country>sample string 8</country>
    <id>1</id>
    <isPreferredBillingAddress>true</isPreferredBillingAddress>
    <isPreferredMailingAddress>true</isPreferredMailingAddress>
    <isPreferredShippingAddress>true</isPreferredShippingAddress>
    <line1>sample string 3</line1>
    <line2>sample string 4</line2>
    <name>sample string 2</name>
    <postalCode>sample string 7</postalCode>
    <stateProvince>sample string 6</stateProvince>
  </v1_ProfilePersons_ProfilePersonEndpointController.GetProfilePersonAllAddressesOutput>
  <v1_ProfilePersons_ProfilePersonEndpointController.GetProfilePersonAllAddressesOutput>
    <city>sample string 5</city>
    <country>sample string 8</country>
    <id>1</id>
    <isPreferredBillingAddress>true</isPreferredBillingAddress>
    <isPreferredMailingAddress>true</isPreferredMailingAddress>
    <isPreferredShippingAddress>true</isPreferredShippingAddress>
    <line1>sample string 3</line1>
    <line2>sample string 4</line2>
    <name>sample string 2</name>
    <postalCode>sample string 7</postalCode>
    <stateProvince>sample string 6</stateProvince>
  </v1_ProfilePersons_ProfilePersonEndpointController.GetProfilePersonAllAddressesOutput>
</ArrayOfv1_ProfilePersons_ProfilePersonEndpointController.GetProfilePersonAllAddressesOutput>