Symphony API V1.0 Web Service

Symphony API V1.0

Click here for a complete list of operations.

GetAttendeesBySearchCriteria

This method can be used to retrieve the details of attendee's based on the search criteria specified

Test

The test form is only available for requests from the local machine.

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/GetAttendeesBySearchCriteria"

<?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>
    <GetAttendeesBySearchCriteria xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <forename>string</forename>
      <surname>string</surname>
      <emailAddress>string</emailAddress>
      <organisationNames>
        <string>string</string>
        <string>string</string>
      </organisationNames>
      <eventFromDate>dateTime</eventFromDate>
      <eventToDate>dateTime</eventToDate>
    </GetAttendeesBySearchCriteria>
  </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>
    <GetAttendeesBySearchCriteriaResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetAttendeesBySearchCriteriaResult>
        <AttendeeResponse2>
          <AttendeeId>int</AttendeeId>
          <AttendeeReference>string</AttendeeReference>
          <ContactId>int</ContactId>
          <BookingId>int</BookingId>
          <EventId>int</EventId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Mobile>string</Mobile>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <AttendedStatus>boolean</AttendedStatus>
          <EventTitle>string</EventTitle>
          <EventRoom>string</EventRoom>
          <EventLocation>string</EventLocation>
          <EventType>string</EventType>
          <EventStartDate>dateTime</EventStartDate>
          <EventEndDate>dateTime</EventEndDate>
        </AttendeeResponse2>
        <AttendeeResponse2>
          <AttendeeId>int</AttendeeId>
          <AttendeeReference>string</AttendeeReference>
          <ContactId>int</ContactId>
          <BookingId>int</BookingId>
          <EventId>int</EventId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Mobile>string</Mobile>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <AttendedStatus>boolean</AttendedStatus>
          <EventTitle>string</EventTitle>
          <EventRoom>string</EventRoom>
          <EventLocation>string</EventLocation>
          <EventType>string</EventType>
          <EventStartDate>dateTime</EventStartDate>
          <EventEndDate>dateTime</EventEndDate>
        </AttendeeResponse2>
      </GetAttendeesBySearchCriteriaResult>
    </GetAttendeesBySearchCriteriaResponse>
  </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>
    <GetAttendeesBySearchCriteria xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <forename>string</forename>
      <surname>string</surname>
      <emailAddress>string</emailAddress>
      <organisationNames>
        <string>string</string>
        <string>string</string>
      </organisationNames>
      <eventFromDate>dateTime</eventFromDate>
      <eventToDate>dateTime</eventToDate>
    </GetAttendeesBySearchCriteria>
  </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>
    <GetAttendeesBySearchCriteriaResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetAttendeesBySearchCriteriaResult>
        <AttendeeResponse2>
          <AttendeeId>int</AttendeeId>
          <AttendeeReference>string</AttendeeReference>
          <ContactId>int</ContactId>
          <BookingId>int</BookingId>
          <EventId>int</EventId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Mobile>string</Mobile>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <AttendedStatus>boolean</AttendedStatus>
          <EventTitle>string</EventTitle>
          <EventRoom>string</EventRoom>
          <EventLocation>string</EventLocation>
          <EventType>string</EventType>
          <EventStartDate>dateTime</EventStartDate>
          <EventEndDate>dateTime</EventEndDate>
        </AttendeeResponse2>
        <AttendeeResponse2>
          <AttendeeId>int</AttendeeId>
          <AttendeeReference>string</AttendeeReference>
          <ContactId>int</ContactId>
          <BookingId>int</BookingId>
          <EventId>int</EventId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Mobile>string</Mobile>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <AttendedStatus>boolean</AttendedStatus>
          <EventTitle>string</EventTitle>
          <EventRoom>string</EventRoom>
          <EventLocation>string</EventLocation>
          <EventType>string</EventType>
          <EventStartDate>dateTime</EventStartDate>
          <EventEndDate>dateTime</EventEndDate>
        </AttendeeResponse2>
      </GetAttendeesBySearchCriteriaResult>
    </GetAttendeesBySearchCriteriaResponse>
  </soap12:Body>
</soap12:Envelope>