Symphony API V1.0


Click here for a complete list of operations.

GetBookableSessions

This method can be used to retrieve all bookable sessions for an event

Test

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

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

<?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>
    <GetBookableSessions xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>int</eventId>
    </GetBookableSessions>
  </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>
    <GetBookableSessionsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetBookableSessionsResult>
        <BookableSessionResponse>
          <BookableSessionId>int</BookableSessionId>
          <Title>string</Title>
          <Code>string</Code>
          <AllowGuests>boolean</AllowGuests>
          <Capacity>int</Capacity>
          <EndDateTime>dateTime</EndDateTime>
          <StartDateTime>dateTime</StartDateTime>
          <TaxRate>decimal</TaxRate>
          <GrossPrice>decimal</GrossPrice>
          <WaitingListCapacity>int</WaitingListCapacity>
          <HasWaitingList>boolean</HasWaitingList>
          <MaximumGuests>int</MaximumGuests>
          <SignupCount>int</SignupCount>
          <WaitingListSignupCount>int</WaitingListSignupCount>
          <AttendeeTicketTypes>
            <AttendeeTicketTypeResponse xsi:nil="true" />
            <AttendeeTicketTypeResponse xsi:nil="true" />
          </AttendeeTicketTypes>
          <VenueName>string</VenueName>
          <VenueRoomName>string</VenueRoomName>
        </BookableSessionResponse>
        <BookableSessionResponse>
          <BookableSessionId>int</BookableSessionId>
          <Title>string</Title>
          <Code>string</Code>
          <AllowGuests>boolean</AllowGuests>
          <Capacity>int</Capacity>
          <EndDateTime>dateTime</EndDateTime>
          <StartDateTime>dateTime</StartDateTime>
          <TaxRate>decimal</TaxRate>
          <GrossPrice>decimal</GrossPrice>
          <WaitingListCapacity>int</WaitingListCapacity>
          <HasWaitingList>boolean</HasWaitingList>
          <MaximumGuests>int</MaximumGuests>
          <SignupCount>int</SignupCount>
          <WaitingListSignupCount>int</WaitingListSignupCount>
          <AttendeeTicketTypes>
            <AttendeeTicketTypeResponse xsi:nil="true" />
            <AttendeeTicketTypeResponse xsi:nil="true" />
          </AttendeeTicketTypes>
          <VenueName>string</VenueName>
          <VenueRoomName>string</VenueRoomName>
        </BookableSessionResponse>
      </GetBookableSessionsResult>
    </GetBookableSessionsResponse>
  </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>
    <GetBookableSessions xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>int</eventId>
    </GetBookableSessions>
  </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>
    <GetBookableSessionsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetBookableSessionsResult>
        <BookableSessionResponse>
          <BookableSessionId>int</BookableSessionId>
          <Title>string</Title>
          <Code>string</Code>
          <AllowGuests>boolean</AllowGuests>
          <Capacity>int</Capacity>
          <EndDateTime>dateTime</EndDateTime>
          <StartDateTime>dateTime</StartDateTime>
          <TaxRate>decimal</TaxRate>
          <GrossPrice>decimal</GrossPrice>
          <WaitingListCapacity>int</WaitingListCapacity>
          <HasWaitingList>boolean</HasWaitingList>
          <MaximumGuests>int</MaximumGuests>
          <SignupCount>int</SignupCount>
          <WaitingListSignupCount>int</WaitingListSignupCount>
          <AttendeeTicketTypes>
            <AttendeeTicketTypeResponse xsi:nil="true" />
            <AttendeeTicketTypeResponse xsi:nil="true" />
          </AttendeeTicketTypes>
          <VenueName>string</VenueName>
          <VenueRoomName>string</VenueRoomName>
        </BookableSessionResponse>
        <BookableSessionResponse>
          <BookableSessionId>int</BookableSessionId>
          <Title>string</Title>
          <Code>string</Code>
          <AllowGuests>boolean</AllowGuests>
          <Capacity>int</Capacity>
          <EndDateTime>dateTime</EndDateTime>
          <StartDateTime>dateTime</StartDateTime>
          <TaxRate>decimal</TaxRate>
          <GrossPrice>decimal</GrossPrice>
          <WaitingListCapacity>int</WaitingListCapacity>
          <HasWaitingList>boolean</HasWaitingList>
          <MaximumGuests>int</MaximumGuests>
          <SignupCount>int</SignupCount>
          <WaitingListSignupCount>int</WaitingListSignupCount>
          <AttendeeTicketTypes>
            <AttendeeTicketTypeResponse xsi:nil="true" />
            <AttendeeTicketTypeResponse xsi:nil="true" />
          </AttendeeTicketTypes>
          <VenueName>string</VenueName>
          <VenueRoomName>string</VenueRoomName>
        </BookableSessionResponse>
      </GetBookableSessionsResult>
    </GetBookableSessionsResponse>
  </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/GetBookableSessions?eventId=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"?>
<ArrayOfBookableSessionResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <BookableSessionResponse>
    <BookableSessionId>int</BookableSessionId>
    <Title>string</Title>
    <Code>string</Code>
    <AllowGuests>boolean</AllowGuests>
    <Capacity>int</Capacity>
    <EndDateTime>dateTime</EndDateTime>
    <StartDateTime>dateTime</StartDateTime>
    <TaxRate>decimal</TaxRate>
    <GrossPrice>decimal</GrossPrice>
    <WaitingListCapacity>int</WaitingListCapacity>
    <HasWaitingList>boolean</HasWaitingList>
    <MaximumGuests>int</MaximumGuests>
    <SignupCount>int</SignupCount>
    <WaitingListSignupCount>int</WaitingListSignupCount>
    <AttendeeTicketTypes>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
    </AttendeeTicketTypes>
    <VenueName>string</VenueName>
    <VenueRoomName>string</VenueRoomName>
  </BookableSessionResponse>
  <BookableSessionResponse>
    <BookableSessionId>int</BookableSessionId>
    <Title>string</Title>
    <Code>string</Code>
    <AllowGuests>boolean</AllowGuests>
    <Capacity>int</Capacity>
    <EndDateTime>dateTime</EndDateTime>
    <StartDateTime>dateTime</StartDateTime>
    <TaxRate>decimal</TaxRate>
    <GrossPrice>decimal</GrossPrice>
    <WaitingListCapacity>int</WaitingListCapacity>
    <HasWaitingList>boolean</HasWaitingList>
    <MaximumGuests>int</MaximumGuests>
    <SignupCount>int</SignupCount>
    <WaitingListSignupCount>int</WaitingListSignupCount>
    <AttendeeTicketTypes>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
    </AttendeeTicketTypes>
    <VenueName>string</VenueName>
    <VenueRoomName>string</VenueRoomName>
  </BookableSessionResponse>
</ArrayOfBookableSessionResponse>

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/GetBookableSessions HTTP/1.1
Host: developer.sym-online.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfBookableSessionResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <BookableSessionResponse>
    <BookableSessionId>int</BookableSessionId>
    <Title>string</Title>
    <Code>string</Code>
    <AllowGuests>boolean</AllowGuests>
    <Capacity>int</Capacity>
    <EndDateTime>dateTime</EndDateTime>
    <StartDateTime>dateTime</StartDateTime>
    <TaxRate>decimal</TaxRate>
    <GrossPrice>decimal</GrossPrice>
    <WaitingListCapacity>int</WaitingListCapacity>
    <HasWaitingList>boolean</HasWaitingList>
    <MaximumGuests>int</MaximumGuests>
    <SignupCount>int</SignupCount>
    <WaitingListSignupCount>int</WaitingListSignupCount>
    <AttendeeTicketTypes>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
    </AttendeeTicketTypes>
    <VenueName>string</VenueName>
    <VenueRoomName>string</VenueRoomName>
  </BookableSessionResponse>
  <BookableSessionResponse>
    <BookableSessionId>int</BookableSessionId>
    <Title>string</Title>
    <Code>string</Code>
    <AllowGuests>boolean</AllowGuests>
    <Capacity>int</Capacity>
    <EndDateTime>dateTime</EndDateTime>
    <StartDateTime>dateTime</StartDateTime>
    <TaxRate>decimal</TaxRate>
    <GrossPrice>decimal</GrossPrice>
    <WaitingListCapacity>int</WaitingListCapacity>
    <HasWaitingList>boolean</HasWaitingList>
    <MaximumGuests>int</MaximumGuests>
    <SignupCount>int</SignupCount>
    <WaitingListSignupCount>int</WaitingListSignupCount>
    <AttendeeTicketTypes>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
      <AttendeeTicketTypeResponse>
        <AttendeeType>string</AttendeeType>
        <TicketType>string</TicketType>
        <AttendeeTypeId>int</AttendeeTypeId>
        <TicketTypeId>int</TicketTypeId>
      </AttendeeTicketTypeResponse>
    </AttendeeTicketTypes>
    <VenueName>string</VenueName>
    <VenueRoomName>string</VenueRoomName>
  </BookableSessionResponse>
</ArrayOfBookableSessionResponse>