GET v1/Contacts/{contactID}/Addresses

Return a list of address for a contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

Id of the contact

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of addresses

PageOfOfAddressDTO
NameDescriptionTypeAdditional information
Data

Collection of AddressDTO

None.

PageNumber

integer

None.

PagesTotal

integer

None.

TotalItems

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

DisplayMessage

string

None.

Links

Collection of PageLink

None.

Href

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "AddressID": 1,
      "EntityID": 2,
      "AddressTypeID": "sample string 3",
      "AddressType": {
        "AddressTypeID": "A",
        "Name": "sample string 2"
      },
      "Line1": "sample string 4",
      "Line2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "County": "sample string 8",
      "CountryCode": "sample string 9",
      "Province": "sample string 10",
      "Zip": "sample string 11",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Notes": "sample string 12",
      "RowSource": "sample string 13",
      "isPreferred": true,
      "AddressString": "sample string 14"
    },
    {
      "AddressID": 1,
      "EntityID": 2,
      "AddressTypeID": "sample string 3",
      "AddressType": {
        "AddressTypeID": "A",
        "Name": "sample string 2"
      },
      "Line1": "sample string 4",
      "Line2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "County": "sample string 8",
      "CountryCode": "sample string 9",
      "Province": "sample string 10",
      "Zip": "sample string 11",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Notes": "sample string 12",
      "RowSource": "sample string 13",
      "isPreferred": true,
      "AddressString": "sample string 14"
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:
<PageOfAddressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
    <d2p1:AddressDTO>
      <d2p1:AddressID>1</d2p1:AddressID>
      <d2p1:AddressString>sample string 14</d2p1:AddressString>
      <d2p1:AddressType>
        <d2p1:AddressTypeID>65</d2p1:AddressTypeID>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:AddressType>
      <d2p1:AddressTypeID>sample string 3</d2p1:AddressTypeID>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:CountryCode>sample string 9</d2p1:CountryCode>
      <d2p1:County>sample string 8</d2p1:County>
      <d2p1:EntityID>2</d2p1:EntityID>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Line1>sample string 4</d2p1:Line1>
      <d2p1:Line2>sample string 5</d2p1:Line2>
      <d2p1:Longitude>1.1</d2p1:Longitude>
      <d2p1:Notes>sample string 12</d2p1:Notes>
      <d2p1:Province>sample string 10</d2p1:Province>
      <d2p1:RowSource>sample string 13</d2p1:RowSource>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:Zip>sample string 11</d2p1:Zip>
      <d2p1:isPreferred>true</d2p1:isPreferred>
    </d2p1:AddressDTO>
    <d2p1:AddressDTO>
      <d2p1:AddressID>1</d2p1:AddressID>
      <d2p1:AddressString>sample string 14</d2p1:AddressString>
      <d2p1:AddressType>
        <d2p1:AddressTypeID>65</d2p1:AddressTypeID>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:AddressType>
      <d2p1:AddressTypeID>sample string 3</d2p1:AddressTypeID>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:CountryCode>sample string 9</d2p1:CountryCode>
      <d2p1:County>sample string 8</d2p1:County>
      <d2p1:EntityID>2</d2p1:EntityID>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Line1>sample string 4</d2p1:Line1>
      <d2p1:Line2>sample string 5</d2p1:Line2>
      <d2p1:Longitude>1.1</d2p1:Longitude>
      <d2p1:Notes>sample string 12</d2p1:Notes>
      <d2p1:Province>sample string 10</d2p1:Province>
      <d2p1:RowSource>sample string 13</d2p1:RowSource>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:Zip>sample string 11</d2p1:Zip>
      <d2p1:isPreferred>true</d2p1:isPreferred>
    </d2p1:AddressDTO>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfAddressDTO>