SOAP API - GetContactPointAddress

GetContactPointAddress( ContactPointID ) : ViewContactPointAddress[]

Since: EngageIP v25.2

Returns the list of contact's addresses, or throws an exception of the contact point does not exist.

The returned value from this method call is an array of ViewContactPointAddress objects. A contact point address object consists of the following properties:

ID (Integer) - The unique ID of the contact point address
ContactPointID (Integer) - The ID of the contact point this object is associated with
Address1 (String) - The primary address
Address2 (String) - The secondary address
CityID (Integer) - The ID of the associated city
StateID (Integer) - The ID of the associated state/province
CountryID (Integer) - The ID of the associated country
Zipcode (String) -Zip/Postal code for this address
CountryName (String) - The free form entered country name. EngageIP has settings to either allow free form entry or pick from a list.
StateName (String) - The free form entered state/province name. EngageIP has settings to either allow free form entry or pick from a list.
CityName (String) - The free form entered city name. EngageIP has settings to either allow free form entry or pick from a list.
Name (String) - Concatenation of contact type, name and address
City (String) - The name of the city associated with the CityID
State (String) - The name of the state associated with the StateID
Country (String) - The name of the country associated with the CountryID
JurisdictionCode (Long) - The code used by taxation software for determining the tax amount and the way in which payment of the total tax amount is divided between different tax authorities
StreetSuffix (String) - The name that comes after the main street name such as "Cove", "Drive", "Circle" etc.
StreetNumber (String) - Street number for this address
StreetName (String) - Street name for this address
Pre_AddressDirection (Integer) - The ID of the address direction for the pre-directional component of the address
Post_AddressDirection (Integer) - The ID of the address direction for the post-directional component of the address
Pre_Directional (String) - An address element that indicates geographic location before the street name
Post_Directional (String) - An address element that indicates geographic location after the street name
UserID (Integer) - The ID of the user for which this address belongs
ContactID (Integer) - The ID of the contact for which this address belongs

Parameters:

ContactPointID (Integer) - The ID of the contact point in which to retrieve the list of addresses. An exception will be thrown if the ID does not exist.

Returns:

An array of Contact Point Addresses for the specified contact point

Possible Exceptions:

INVALID CONTACT POINT

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetContactPointAddress xmlns="Logisense_EngageIP">
      <ContactPointtID>int</ContactPointtID>
    </GetContactPointAddress>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetContactPointAddressResponse xmlns="Logisense_EngageIP">
      <GetContactPointAddressResult>
        <ViewContactPointAddress>
          <ID>int</ID>
          <ContactPointID>int</ContactPointID>
          <Address2>string</Address2>
          <CityID>int</CityID>
          <StateID>int</StateID>
          <CountryID>int</CountryID>
          <ZipCode>string</ZipCode>
          <CountryName>string</CountryName>
          <StateName>string</StateName>
          <CityName>string</CityName>
          <Name>string</Name>
          <City>string</City>
          <State>string</State>
          <Country>string</Country>
          <Address1>string</Address1>
          <JurisdictionCode>long</JurisdictionCode>
          <StreetSuffix>string</StreetSuffix>
          <StreetNumber>string</StreetNumber>
          <StreetName>string</StreetName>
          <Pre_AddressDirectionID>int</Pre_AddressDirectionID>
          <Post_AddressDirectionID>int</Post_AddressDirectionID>
          <Pre_Directional>string</Pre_Directional>
          <Post_Directional>string</Post_Directional>
          <UserID>int</UserID>
          <ContactID>int</ContactID>
        </ViewContactPointAddress>
        <ViewContactPointAddress>
          <ID>int</ID>
          <ContactPointID>int</ContactPointID>
          <Address2>string</Address2>
          <CityID>int</CityID>
          <StateID>int</StateID>
          <CountryID>int</CountryID>
          <ZipCode>string</ZipCode>
          <CountryName>string</CountryName>
          <StateName>string</StateName>
          <CityName>string</CityName>
          <Name>string</Name>
          <City>string</City>
          <State>string</State>
          <Country>string</Country>
          <Address1>string</Address1>
          <JurisdictionCode>long</JurisdictionCode>
          <StreetSuffix>string</StreetSuffix>
          <StreetNumber>string</StreetNumber>
          <StreetName>string</StreetName>
          <Pre_AddressDirectionID>int</Pre_AddressDirectionID>
          <Post_AddressDirectionID>int</Post_AddressDirectionID>
          <Pre_Directional>string</Pre_Directional>
          <Post_Directional>string</Post_Directional>
          <UserID>int</UserID>
          <ContactID>int</ContactID>
        </ViewContactPointAddress>
      </GetContactPointAddressResult>
    </GetContactPointAddressResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetContactPointAddress"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetContactPointAddress xmlns="Logisense_EngageIP">
      <ContactPointtID>int</ContactPointtID>
    </GetContactPointAddress>
  </soap:Body>
</soap:Envelope>