Symphony API V1.0


Click here for a complete list of operations.

GetEventsByContactId

This method returns all events associated with a contact

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
contactId:
includeArchived:
isTestBookingForm:

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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetEventsByContactId"

<?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>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetEventsByContactId xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <contactId>int</contactId>
      <includeArchived>boolean</includeArchived>
      <isTestBookingForm>boolean</isTestBookingForm>
    </GetEventsByContactId>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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:Body>
    <GetEventsByContactIdResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetEventsByContactIdResult>
        <ContactEventResponse>
          <ContactId>int</ContactId>
          <EventId>int</EventId>
          <EventName>string</EventName>
          <StartDateAndTime>string</StartDateAndTime>
          <CPDValue>int</CPDValue>
          <DefaultBookingFormId>int</DefaultBookingFormId>
          <BookingFormUsedId>int</BookingFormUsedId>
        </ContactEventResponse>
        <ContactEventResponse>
          <ContactId>int</ContactId>
          <EventId>int</EventId>
          <EventName>string</EventName>
          <StartDateAndTime>string</StartDateAndTime>
          <CPDValue>int</CPDValue>
          <DefaultBookingFormId>int</DefaultBookingFormId>
          <BookingFormUsedId>int</BookingFormUsedId>
        </ContactEventResponse>
      </GetEventsByContactIdResult>
    </GetEventsByContactIdResponse>
  </soap:Body>
</soap:Envelope>

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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.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>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetEventsByContactId xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <contactId>int</contactId>
      <includeArchived>boolean</includeArchived>
      <isTestBookingForm>boolean</isTestBookingForm>
    </GetEventsByContactId>
  </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>
    <GetEventsByContactIdResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetEventsByContactIdResult>
        <ContactEventResponse>
          <ContactId>int</ContactId>
          <EventId>int</EventId>
          <EventName>string</EventName>
          <StartDateAndTime>string</StartDateAndTime>
          <CPDValue>int</CPDValue>
          <DefaultBookingFormId>int</DefaultBookingFormId>
          <BookingFormUsedId>int</BookingFormUsedId>
        </ContactEventResponse>
        <ContactEventResponse>
          <ContactId>int</ContactId>
          <EventId>int</EventId>
          <EventName>string</EventName>
          <StartDateAndTime>string</StartDateAndTime>
          <CPDValue>int</CPDValue>
          <DefaultBookingFormId>int</DefaultBookingFormId>
          <BookingFormUsedId>int</BookingFormUsedId>
        </ContactEventResponse>
      </GetEventsByContactIdResult>
    </GetEventsByContactIdResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /API/1_0/SOAP/SymphonyAPI.asmx/GetEventsByContactId?contactId=string&includeArchived=string&isTestBookingForm=string HTTP/1.1
Host: developer.sym-online.com

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfContactEventResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <ContactEventResponse>
    <ContactId>int</ContactId>
    <EventId>int</EventId>
    <EventName>string</EventName>
    <StartDateAndTime>string</StartDateAndTime>
    <CPDValue>int</CPDValue>
    <DefaultBookingFormId>int</DefaultBookingFormId>
    <BookingFormUsedId>int</BookingFormUsedId>
  </ContactEventResponse>
  <ContactEventResponse>
    <ContactId>int</ContactId>
    <EventId>int</EventId>
    <EventName>string</EventName>
    <StartDateAndTime>string</StartDateAndTime>
    <CPDValue>int</CPDValue>
    <DefaultBookingFormId>int</DefaultBookingFormId>
    <BookingFormUsedId>int</BookingFormUsedId>
  </ContactEventResponse>
</ArrayOfContactEventResponse>

HTTP POST

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

POST /API/1_0/SOAP/SymphonyAPI.asmx/GetEventsByContactId HTTP/1.1
Host: developer.sym-online.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

contactId=string&includeArchived=string&isTestBookingForm=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfContactEventResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <ContactEventResponse>
    <ContactId>int</ContactId>
    <EventId>int</EventId>
    <EventName>string</EventName>
    <StartDateAndTime>string</StartDateAndTime>
    <CPDValue>int</CPDValue>
    <DefaultBookingFormId>int</DefaultBookingFormId>
    <BookingFormUsedId>int</BookingFormUsedId>
  </ContactEventResponse>
  <ContactEventResponse>
    <ContactId>int</ContactId>
    <EventId>int</EventId>
    <EventName>string</EventName>
    <StartDateAndTime>string</StartDateAndTime>
    <CPDValue>int</CPDValue>
    <DefaultBookingFormId>int</DefaultBookingFormId>
    <BookingFormUsedId>int</BookingFormUsedId>
  </ContactEventResponse>
</ArrayOfContactEventResponse>