GET v1/Locations/{locationID}/Address

Get the locations main address

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

None.

Response Information

Resource Description

Location main address

AddressDTO
NameDescriptionTypeAdditional information
AddressID

Id of the address

integer

None.

EntityID

Id of the entity

integer

None.

AddressTypeID

Address type id

string

None.

AddressType

Address type

AddressTypeDTO

None.

Line1

Line 1

string

None.

Line2

Line 2

string

None.

City

City

string

None.

State

State

string

None.

County

Country

string

None.

CountryCode

Country code

string

None.

Province

Province

string

None.

Zip

ZIP code

string

None.

Latitude

Latitude

decimal number

None.

Longitude

Longitude

decimal number

None.

Notes

Notes

string

None.

RowSource

Row source

string

None.

isPreferred

Signifies whether the address is preferred

boolean

None.

AddressString

Address as string

string

None.

Response Formats

application/json, text/json

Sample:
{
  "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"
}

application/xml, text/xml

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