GET v1/Locations/{locationID}/Address
Get the locations main address
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationID |
Id of the location |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Location main address
AddressDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressID | integer |
None. |
|
| EntityID | integer |
None. |
|
| AddressTypeID | string |
None. |
|
| AddressType | AddressTypeDTO |
None. |
|
| Line1 | string |
None. |
|
| Line2 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| County | string |
None. |
|
| CountryCode | string |
None. |
|
| Province | string |
None. |
|
| Zip | string |
None. |
|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| Notes | string |
None. |
|
| RowSource | string |
None. |
|
| isPreferred | boolean |
None. |
|
| AddressString | 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>