Symphony API V1.0
Click here for a complete list of operations.
GetExtBookingsBatch
This method can be used to retrieve all bookings for an event with extended info, in batches for paging results
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/GetExtBookingsBatch"
<?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>
<GetExtBookingsBatch xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<eventId>int</eventId>
<skip>int</skip>
<size>int</size>
</GetExtBookingsBatch>
</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>
<GetExtBookingsBatchResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<GetExtBookingsBatchResult>
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse xsi:nil="true" />
<AttendeeExtResponse xsi:nil="true" />
</Attendees>
</BookingExtResponse>
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse xsi:nil="true" />
<AttendeeExtResponse xsi:nil="true" />
</Attendees>
</BookingExtResponse>
</GetExtBookingsBatchResult>
</GetExtBookingsBatchResponse>
</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>
<GetExtBookingsBatch xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<eventId>int</eventId>
<skip>int</skip>
<size>int</size>
</GetExtBookingsBatch>
</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>
<GetExtBookingsBatchResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<GetExtBookingsBatchResult>
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse xsi:nil="true" />
<AttendeeExtResponse xsi:nil="true" />
</Attendees>
</BookingExtResponse>
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse xsi:nil="true" />
<AttendeeExtResponse xsi:nil="true" />
</Attendees>
</BookingExtResponse>
</GetExtBookingsBatchResult>
</GetExtBookingsBatchResponse>
</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/GetExtBookingsBatch?eventId=string&skip=string&size=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"?>
<ArrayOfBookingExtResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
</Attendees>
</BookingExtResponse>
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
</Attendees>
</BookingExtResponse>
</ArrayOfBookingExtResponse>
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/GetExtBookingsBatch HTTP/1.1 Host: developer.sym-online.com Content-Type: application/x-www-form-urlencoded Content-Length: length eventId=string&skip=string&size=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfBookingExtResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
</Attendees>
</BookingExtResponse>
<BookingExtResponse>
<BookingId>int</BookingId>
<BookingReference>string</BookingReference>
<BookingStatus>string</BookingStatus>
<CreatedDate>dateTime</CreatedDate>
<GrossCost>decimal</GrossCost>
<NetCost>decimal</NetCost>
<Tax>decimal</Tax>
<IsTest>boolean</IsTest>
<Attendees>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
<AttendeeExtResponse>
<AttendeeId>int</AttendeeId>
<AttendeeReference>string</AttendeeReference>
<AttendeeStatus>string</AttendeeStatus>
<DateCreated>dateTime</DateCreated>
<AttendeeType>string</AttendeeType>
<AttendeeTypeId>int</AttendeeTypeId>
<TicketType>string</TicketType>
<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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CustomFieldValues d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BookableSessionSignups d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Reservations d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<CountryCode>string</CountryCode>
<AttendedStatus>boolean</AttendedStatus>
</AttendeeExtResponse>
</Attendees>
</BookingExtResponse>
</ArrayOfBookingExtResponse>