SOAP API - CreateContactPoint

CreateContactPoint( username, contactID, contactPointTypeName, value ) : Integer

Since: EngageIP v25.2

Creates a new contact point for a contact belonging to a specified user and returns the ID on the new contact point

This method will throw an exception if either the user does not have a contact of the specified ID, the contact type does not exist, or the contactPointType Address is specified. The exception on contact point type "Address" is thrown because address contact points must be created with the CreateContactPointAddress method, and cannot be successfully created with the CreateContactPoint method.

Parameters:

  • username (String) - The name of the user in which to add a new contact point type.  An exception will be thrown if the username does not exist.

  • contactID (Integer)  - The ID of the contact for whom this contact information will be added.  An exception will be thrown if the contact ID does not exist.

  • contactPointTypeName (String) - The type of contact point that is being added

  • value (String) - The data containing the details of the contact point.  An example would an email address, phone number etc.  Address information must be added using the CreateContactPointAddress method.

Returns:

The new contact point ID

Possible Exceptions:

  • INVALID USERNAME

  • INVALID CONTACT ID

  • INVALID CONTACT POINT TYPE NAME

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> <CreateContactPoint xmlns="Logisense_EngageIP"> <username>string</username> <contactID>int</contactID> <contactPointTypeName>string</contactPointTypeName> <value>string</value> </CreateContactPoint> </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> <CreateContactPointResponse xmlns="Logisense_EngageIP"> <CreateContactPointResult>int</CreateContactPointResult> </CreateContactPointResponse> </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/CreateContactPoint" <?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> <CreateContactPoint xmlns="Logisense_EngageIP"> <username>string</username> <contactID>int</contactID> <contactPointTypeName>string</contactPointTypeName> <value>string</value> </CreateContactPoint> </soap:Body> </soap:Envelope>