SOAP API - GetContacts

GetContacts( username ) : Contact[]

Since: EngageIP v25.2

Returns the list of a user's contacts, or throws an exception if the user does not exist.

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

ID (Integer) - The unique ID of the contact type
ContactTypeID (Integer) - The ID of the ContactType associated with this contact.
Name (String) - The name of the contact
Title (String) - The specified title of the contact
FirstName (String) - The first name of the contact
LastName (String) - The last name of the contact
Company (String) - This contact's associated company name

Parameters:

username (String) - The username in which to retrieve the list of contacts. An exception will be thrown if the ID does not exist.

Returns:

An array of Contacts for the specified user

Possible Exceptions:

INVALID USERNAME

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>
    <GetContacts xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetContacts>
  </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>
    <GetContactTypesResponse xmlns="Logisense_EngageIP">
      <GetContactTypesResult>
        <ContactType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <BillingContact>boolean</BillingContact>
          <EmailContact>boolean</EmailContact>
          <ServiceContact>boolean</ServiceContact>
          <Required>boolean</Required>
          <ReceiveTickets>boolean</ReceiveTickets>
          <ShowToAddAccount>boolean</ShowToAddAccount>
          <ShippingContact>boolean</ShippingContact>
        </ContactType>
        <ContactType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <BillingContact>boolean</BillingContact>
          <EmailContact>boolean</EmailContact>
          <ServiceContact>boolean</ServiceContact>
          <Required>boolean</Required>
          <ReceiveTickets>boolean</ReceiveTickets>
          <ShowToAddAccount>boolean</ShowToAddAccount>
          <ShippingContact>boolean</ShippingContact>
        </ContactType>
      </GetContactTypesResult>
    </GetContactTypesResponse>
  </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/GetContacts"

<?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>
    <GetContacts xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetContacts>
  </soap:Body>
</soap:Envelope>