Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎3 - Profile Store‎ > ‎

Get Addresses

Will get the list of all addresses stored for the consumer.  AddressKey is the property to use for editing and deleting.

Method: GET /api/v3/publisher/profilestore/{userKey}/addresses

Authentication: oauth
 
Parameters
Required Url Value
Explanation
Yes
userKey
The UserKey for the profile/consumer record.

Returns
base response fields
addresses - Will return a list of addresses.

Sample Request:

GET http://api.groupcommerce.com/api/v3/publisher/profilestore/UserKey1/addresses

Authorization: OAuth oauth_signature="DK3j50RXTlu2qwXKzf7r8cuck6U%3D", oauth_nonce="911332", oauth_timestamp="1361930346", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"

Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1361930342621)/",
    "success": true,
    "version": "3",
    "metaData": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 1,
        "totalItems": 1
    },
    "addresses": [
        {
            "address1": "628 Broadway",
            "address2": "5th",
            "addressKey": "Work",
            "city": "New York City",
            "country": "US",
            "name": "Home",
            "phone": "111 222 3333 x 4557",
            "postalCode": "11218",
            "state": "NY"
        },
        {
            "address1": "628 Broadway",
            "address2": "",
            "addressKey": "Home",
            "city": "New York City",
            "country": "US",
            "name": "Home",
            "phone": "111 222 3333 x 4557",
            "postalCode": "11218",
            "state": "NY"
        }
   
    ]
}


Sample XML Response:

<getAddressesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <errors />
  <lastPublished>2013-02-27T02:03:42.9309213Z</lastPublished>
  <success>true</success>
  <version>3</version>
  <metaData>
    <pageCount>1</pageCount>
    <pageNumber>1</pageNumber>
    <pageSize>1</pageSize>
    <totalItems>1</totalItems>
  </metaData>
  <addresses>
    <address>
      <address1>628 Broadway</address1>
      <address2 />
      <addressKey>french</addressKey>
      <city>London</city>
      <country>US</country>
      <name>home</name>
      <phone>111 222 3333 x 4557</phone>
      <postalCode>11218</postalCode>
      <state>Botswana</state>
    </address>
    <address>
      <address1>628 Broadway</address1>
      <address2 />
      <addressKey>french</addressKey>
      <city>London</city>
      <country>US</country>
      <name>home</name>
      <phone>111 222 3333 x 4557</phone>
      <postalCode>11218</postalCode>
      <state>Botswana</state>
    </address>
  </addresses>
</getAddressesResponse>
Comments