GET {clientId}/AddressTypes?Id={Id}&locale={locale}

This method allows you to retrieve a collection of previously defined AddressTypes. AddressTypes are used for classifying mailing addresses on a user’s profile such as Home, Business or Shipping. Each mailing address on a user’s profile must be associated with an AddressType. The "Name" and "Description" fields on AddressTypes support localization which helps you drive multilingual experiences across customer touchpoints.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	This is your organization’s MyPreferences Account Id.	string	Required
Id	Optional Type Id. If specified, only the Type with this Id will be returned.	integer	Default value is 0
locale	A valid locale associated with the AddressType. Ex: “en”, “en-us”, “en-uk”, “fr-ca”.	string

Body Parameters

None.

Response Information

Response Codes

HTTP Status Code	Text	Description
200	OK	The request was successfully processed.
400	Bad Request	The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403	Forbidden	The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

AddressTypeEntryList

Name	Description	Type	Additional information
AddressTypes	A collection of meta data describing type information for an Address that can be associated with a Profile	Collection of AddressTypeEntry

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "AddressTypes": [
    {
      "TypeId": 1,
      "Edited": {
        "CreateDate": "sample string 1",
        "CreatedBy": "sample string 2",
        "ModifiedDate": "sample string 3",
        "ModifiedBy": "sample string 4"
      },
      "TypeName": "sample string 2",
      "LocalizedFields": [
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ],
      "IsDefault": true,
      "IsActive": true
    },
    {
      "TypeId": 1,
      "Edited": {
        "CreateDate": "sample string 1",
        "CreatedBy": "sample string 2",
        "ModifiedDate": "sample string 3",
        "ModifiedBy": "sample string 4"
      },
      "TypeName": "sample string 2",
      "LocalizedFields": [
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ],
      "IsDefault": true,
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample:

<AddressTypeEntryList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <AddressTypes>
    <AddressTypeEntry>
      <IsActive>true</IsActive>
      <IsDefault>true</IsDefault>
      <LocalizedFields>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
      </LocalizedFields>
      <TypeName>sample string 2</TypeName>
      <Edited>
        <CreateDate>sample string 1</CreateDate>
        <CreatedBy>sample string 2</CreatedBy>
        <ModifiedBy>sample string 4</ModifiedBy>
        <ModifiedDate>sample string 3</ModifiedDate>
      </Edited>
      <TypeId>1</TypeId>
    </AddressTypeEntry>
    <AddressTypeEntry>
      <IsActive>true</IsActive>
      <IsDefault>true</IsDefault>
      <LocalizedFields>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
      </LocalizedFields>
      <TypeName>sample string 2</TypeName>
      <Edited>
        <CreateDate>sample string 1</CreateDate>
        <CreatedBy>sample string 2</CreatedBy>
        <ModifiedBy>sample string 4</ModifiedBy>
        <ModifiedDate>sample string 3</ModifiedDate>
      </Edited>
      <TypeId>1</TypeId>
    </AddressTypeEntry>
  </AddressTypes>
</AddressTypeEntryList>