Symphony API V1.0 Web Service

Symphony API V1.0

Click here for a complete list of operations.

AddAttendeesToBooking

This method can be used to add attendees to an existing booking

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

<?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>
    <AddAttendeesToBooking xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingId>int</bookingId>
      <eventId>int</eventId>
      <attendees>
        <AttendeeRequest>
          <AttendeeTypeId>int</AttendeeTypeId>
          <ContactId>int</ContactId>
          <Reference>string</Reference>
          <Code>string</Code>
          <TicketTypeId>int</TicketTypeId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <PAName>string</PAName>
          <MarketingOptOut>boolean</MarketingOptOut>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <Town>string</Town>
          <County>string</County>
          <Postcode>string</Postcode>
          <Country>string</Country>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Mobile>string</Mobile>
          <Website>string</Website>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <Attendance>
            <dateTime>dateTime</dateTime>
            <dateTime>dateTime</dateTime>
          </Attendance>
          <CustomFieldValues>
            <CustomFieldValueRequest xsi:nil="true" />
            <CustomFieldValueRequest xsi:nil="true" />
          </CustomFieldValues>
          <BookableSessionSignups>
            <BookableSessionSignupRequest xsi:nil="true" />
            <BookableSessionSignupRequest xsi:nil="true" />
          </BookableSessionSignups>
          <Reservations>
            <ReservationRequest xsi:nil="true" />
            <ReservationRequest xsi:nil="true" />
          </Reservations>
        </AttendeeRequest>
        <AttendeeRequest>
          <AttendeeTypeId>int</AttendeeTypeId>
          <ContactId>int</ContactId>
          <Reference>string</Reference>
          <Code>string</Code>
          <TicketTypeId>int</TicketTypeId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <PAName>string</PAName>
          <MarketingOptOut>boolean</MarketingOptOut>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <Town>string</Town>
          <County>string</County>
          <Postcode>string</Postcode>
          <Country>string</Country>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Mobile>string</Mobile>
          <Website>string</Website>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <Attendance>
            <dateTime>dateTime</dateTime>
            <dateTime>dateTime</dateTime>
          </Attendance>
          <CustomFieldValues>
            <CustomFieldValueRequest xsi:nil="true" />
            <CustomFieldValueRequest xsi:nil="true" />
          </CustomFieldValues>
          <BookableSessionSignups>
            <BookableSessionSignupRequest xsi:nil="true" />
            <BookableSessionSignupRequest xsi:nil="true" />
          </BookableSessionSignups>
          <Reservations>
            <ReservationRequest xsi:nil="true" />
            <ReservationRequest xsi:nil="true" />
          </Reservations>
        </AttendeeRequest>
      </attendees>
      <purchaseOrderNumber>string</purchaseOrderNumber>
      <codesUsed>
        <string>string</string>
        <string>string</string>
      </codesUsed>
      <confirmationUrl>string</confirmationUrl>
      <isTest>boolean</isTest>
    </AddAttendeesToBooking>
  </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>
    <AddAttendeesToBookingResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <AddAttendeesToBookingResult>int</AddAttendeesToBookingResult>
    </AddAttendeesToBookingResponse>
  </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>
    <AddAttendeesToBooking xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingId>int</bookingId>
      <eventId>int</eventId>
      <attendees>
        <AttendeeRequest>
          <AttendeeTypeId>int</AttendeeTypeId>
          <ContactId>int</ContactId>
          <Reference>string</Reference>
          <Code>string</Code>
          <TicketTypeId>int</TicketTypeId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <PAName>string</PAName>
          <MarketingOptOut>boolean</MarketingOptOut>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <Town>string</Town>
          <County>string</County>
          <Postcode>string</Postcode>
          <Country>string</Country>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Mobile>string</Mobile>
          <Website>string</Website>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <Attendance>
            <dateTime>dateTime</dateTime>
            <dateTime>dateTime</dateTime>
          </Attendance>
          <CustomFieldValues>
            <CustomFieldValueRequest xsi:nil="true" />
            <CustomFieldValueRequest xsi:nil="true" />
          </CustomFieldValues>
          <BookableSessionSignups>
            <BookableSessionSignupRequest xsi:nil="true" />
            <BookableSessionSignupRequest xsi:nil="true" />
          </BookableSessionSignups>
          <Reservations>
            <ReservationRequest xsi:nil="true" />
            <ReservationRequest xsi:nil="true" />
          </Reservations>
        </AttendeeRequest>
        <AttendeeRequest>
          <AttendeeTypeId>int</AttendeeTypeId>
          <ContactId>int</ContactId>
          <Reference>string</Reference>
          <Code>string</Code>
          <TicketTypeId>int</TicketTypeId>
          <Title>string</Title>
          <Forename>string</Forename>
          <Surname>string</Surname>
          <Organisation>string</Organisation>
          <Occupation>string</Occupation>
          <PAName>string</PAName>
          <MarketingOptOut>boolean</MarketingOptOut>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <Town>string</Town>
          <County>string</County>
          <Postcode>string</Postcode>
          <Country>string</Country>
          <Email>string</Email>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Mobile>string</Mobile>
          <Website>string</Website>
          <IsLeadAttendee>boolean</IsLeadAttendee>
          <Attendance>
            <dateTime>dateTime</dateTime>
            <dateTime>dateTime</dateTime>
          </Attendance>
          <CustomFieldValues>
            <CustomFieldValueRequest xsi:nil="true" />
            <CustomFieldValueRequest xsi:nil="true" />
          </CustomFieldValues>
          <BookableSessionSignups>
            <BookableSessionSignupRequest xsi:nil="true" />
            <BookableSessionSignupRequest xsi:nil="true" />
          </BookableSessionSignups>
          <Reservations>
            <ReservationRequest xsi:nil="true" />
            <ReservationRequest xsi:nil="true" />
          </Reservations>
        </AttendeeRequest>
      </attendees>
      <purchaseOrderNumber>string</purchaseOrderNumber>
      <codesUsed>
        <string>string</string>
        <string>string</string>
      </codesUsed>
      <confirmationUrl>string</confirmationUrl>
      <isTest>boolean</isTest>
    </AddAttendeesToBooking>
  </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>
    <AddAttendeesToBookingResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <AddAttendeesToBookingResult>int</AddAttendeesToBookingResult>
    </AddAttendeesToBookingResponse>
  </soap12:Body>
</soap12:Envelope>