GET api/contacts/{id}/contactaddresses?addressTypeId={addressTypeId}&streetAddressLine1Contains={streetAddressLine1Contains}&townSuburb={townSuburb}&townSuburbContains={townSuburbContains}&stateCity={stateCity}&stateCityContains={stateCityContains}&postcode={postcode}&countryId={countryId}

Get all ContactAddress records associated with a parent Contact record, optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Optional filter on ContactAddresses associated with a parent Contact id (CrmNumber) that matches the provided value.

 integer

Required
addressTypeId

Optional filter on ContactAddresses with an addressTypeId that matches the provided value.

 integer

None.
streetAddressLine1Contains

Optional case-insensitive filter on ContactAddresses with a StreetAddressLine1 containing the provided value.

 string

None.
townSuburb

Optional case-insensitive filter on ContactAddresses with a TownSuburb that matches the provided value.

 string

None.
townSuburbContains

Optional case-insensitive filter on ContactAddresses with a TownSuburb containing the provided value.

 string

None.
stateCity

Optional case-insensitive filter on ContactAddresses with a StateCity that matches the provided value.

 string

None.
stateCityContains

Optional case-insensitive filter on ContactAddresses with a StateCity containing the provided value.

 string

None.
postcode

Optional case-insensitive filter on ContactAddresses with a Postcode that matches the provided value.

 string

None.
countryId

Optional filter on ContactAddresses with a CountryId that matches the provided value.

 integer

None.

Body Parameters

None.

Response Information

Resource Description

ContactAddressDto
NameDescriptionTypeAdditional information
CrmNumber

A reference to the primary key of the Contact record that is associated with the ContactAddress. Ignored for PUT (except bulk updates) and POST (except bulk inserts) requests sent to the API.

 integer

None.
AddressTypeId

A reference to the primary key of the AddressType record that is binded to the ContactAddress. Ignored for PUT (except bulk updates) requests sent to the API.

 integer

Required

Range: inclusive between 1 and 99999999
AddressTypeName

The name of the AddressType record that is binded to the ContactAddress. Ignored for PUT and POST requests sent to the API.

 string

None.
StreetAddressLine1

The address of the ContactAddress (i.e. Unit Number, Street Number, Street Name).

 string

String length: inclusive between 0 and 200
StreetAddressLine2

Further information that may not fit on Address Line 1.

 string

String length: inclusive between 0 and 200
StreetAddressLine3

Further information that may not fit on Address Line 1 and 2.

 string

String length: inclusive between 0 and 200
TownSuburb

string

String length: inclusive between 0 and 120
StateCity

string

String length: inclusive between 0 and 120
Postcode

string

String length: inclusive between 0 and 15
CountryId

A reference to the primary key of the Country record that is binded to the ContactAddress.

 integer

Range: inclusive between 1 and 99999999
CountryName

The name of the Country record that is binded to the ContactAddress. Ignored for PUT and POST requests sent to the API.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CrmNumber": 1,
  "AddressTypeId": 2,
  "AddressTypeName": "sample string 3",
  "StreetAddressLine1": "sample string 4",
  "StreetAddressLine2": "sample string 5",
  "StreetAddressLine3": "sample string 6",
  "TownSuburb": "sample string 7",
  "StateCity": "sample string 8",
  "Postcode": "sample string 9",
  "CountryId": 1,
  "CountryName": "sample string 10"
}