Symphony API Help

An exploration of the functionality available using the Symphony web services API, including examples of use.

Url

https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx

Authentication

To access the API you need to have two valid access keys an API key and secret key.

API key

The API key uniquely identifies the client using the API. It is always required on each web service request but does not need to be encrypted.

Secret key

The secret key is known only within the Symphony system and the client. The secret key is used to create a signature SHA1 hash for each request. This can be compared to the same hash computed on the Symphony system to validate the request is genuine.

Authentication request header

All requests made to the SOAP web methods must contain a SOAP header. The SOAP header 'AuthenticationHeader' contains four values.

Timestamp

The timestamp is generated from the current date and time in a ISO time format e.g. 2010-04-09T09:08Z (http://en.wikipedia.org/wiki/ISO_8601)

Operation

The name of the web service operation requested.

API key

The API key is simply the API key as supplied to you.

Signature

The signature is based on the operation being requested and the timestamp.

Example: Timestamp generation (.Net)

protected string CreateTimestamp()
{
    string isoTimeStamp = DateTime.Now.ToUniversalTime()
        .ToString("yyyy-MM-ddTHH:mm:ss.fffZ", System.Globalization.CultureInfo.InvariantCulture);
    return isoTimeStamp;
}

Example: Signature generation (.Net)

protected string CreateSignature(string operation, string timestamp)
{
    Encoding encoding = new UTF8Encoding();
    HMACSHA1 hash = new HMACSHA1(encoding.GetBytes(SecretKey));

    string rawSignature = operation + timestamp;

    byte[] computedHash = hash.ComputeHash(encoding.GetBytes(rawSignature));

    string signature = Convert.ToBase64String(computedHash);

    return signature;
}

API methods

• CancelAttendee
• CancelBooking
• GetAccommodation
• GetAttendeeTypes
• GetBookableSessions
• GetBookingDetails
• GetBooking
• GetBookings
• GetContact
• GetContacts
• GetCountries
• GetCustomFields
• GetDays
• GetEventDetails
• GetInvoiceDetails
• GetInvoices
• GetTicketTypes
• SubmitBooking
• SubmitContact

CancelAttendee

This operation updates an attendee and sets its status to the default cancelled status.

Parameters

1. attendeeReference (string)

Return type

None

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/CancelAttendee"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>CancelAttendee</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <CancelAttendee xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <attendeeReference>A00001</attendeeReference>
    </CancelAttendee>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CancelAttendeeResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/" />
  </soap:Body>
</soap:Envelope>

CancelBooking

Parameters

1. bookingReference (string)

Return type

None

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/CancelBooking"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>CancelBooking</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <CancelBooking xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingReference>B001</bookingReference>
    </CancelBooking>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CancelBookingResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/" />
  </soap:Body>
</soap:Envelope>

GetAccommodation

Parameters

1. eventId (int)

Return type

HotelResponse

• HotelId (int)
• Name (string)
• Code (string)
• Line1 (string)
• Line2 (string)
• Line3 (string)
• Town (string)
• County (string)
• Postcode (string)
• Country (string)
• Email (string)
• Telephone (string)
• Fax (string)
• Mobile (string)
• Website (string)
• RoomTypeResponse
  • RoomTypeId (int)
  • Name (string)
  • Code (string)
  • Description (string)
  • NightResponse
    • AccommodationRoomTypeNightId (int)
    • Capacity (int)
    • ReservationCount (int)
    • Night (DateTime)

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetAccommodation"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetAccommodation</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetAccommodation xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetAccommodation>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetAccommodationResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetAccommodationResult />
    </GetAccommodationResponse>
  </soap:Body>
</soap:Envelope>

GetAttendeeTypes

Parameters

1. eventId (int)

Return type

AttendeeTypeResponse

• AttendeeTypeId (int)
• Name (string)
• TicketTypeResponse
  • TicketTypeId (int)
  • Name (string)
  • Capacity (int)
  • GrossPrice (decimal)
  • TaxRate (decimal)
  • AttendeeCount (int)
  • NumberOfDaysValid (int)
  • IsOpen (boolean)
  • AvailabilityStartDate (DateTime)
  • AvailabilityEndDate (DateTime)
  • TicketAttendanceTypeResponse
    • Id (int)
    • Name (string)
  • TicketTypeDayResponse
    • Date (DateTime)

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetAttendeeTypes"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetAttendeeTypes</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetAttendeeTypes xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetAttendeeTypes>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetAttendeeTypesResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetAttendeeTypesResult>
        <AttendeeTypeResponse>
          <AttendeeTypeId>1</AttendeeTypeId>
          <Name>Developer</Name>
          <TicketTypes>
            <TicketTypeResponse>
              <TicketTypeId>1</TicketTypeId>
              <Name>Standard</Name>
              <Capacity xsi:nil="true" />
              <GrossPrice>0.00000</GrossPrice>
              <TaxRate>0.00000</TaxRate>
              <AttendeeCount>0</AttendeeCount>
              <NumberOfDaysValid xsi:nil="true" />
              <IsOpen>false</IsOpen>
              <AvailabilityStartDate>2010-01-01T00:00:00</AvailabilityStartDate>
              <AvailabilityEndDate>2010-02-01T00:00:00</AvailabilityEndDate>
              <AttendanceType>
                <TicketAttendanceTypeResponse>
                  <Id>1</Id>
                  <Name>All days</Name>
                </TicketAttendanceTypeResponse>
              </AttendanceType>
              <TicketTypeDays>
                <TicketTypeDayResponse>
                  <Date>2010-01-01T00:00:00</Date>
                </TicketTypeDayResponse>
              </TicketTypeDays>
            </TicketTypeResponse>
          </TicketTypes>
        </AttendeeTypeResponse>
      </GetAttendeeTypesResult>
    </GetAttendeeTypesResponse>
  </soap:Body>
</soap:Envelope>

GetBookableSessions

Parameters

1. eventId (int)

Return type

BookableSessionResponse

• BookableSessionId (int)
• Title (string)
• Code (string)
• AllowGuests (boolean)
• Capacity (int)
• EndDateTime (DateTime)
• StartDateTime (DateTime)
• TaxRate (decimal)
• GrossPrice (decimal)
• WaitingListCapacity (int)
• HasWaitingList (boolean)
• MaximumGuests (int)
• SignupCount (int)
• WaitingListSignupCount (int)
• VenueName (string)
• VenueRoomName (string)
• AttendeeTicketTypeResponse
  • AttendeeTypeId (int)
  • TicketTypeId (int)
  • AttendeeType (string)
  • TicketType (string)

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetBookableSessions"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetBookableSessions</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetBookableSessions xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetBookableSessions>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetBookableSessionsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetBookableSessionsResult>
        <BookableSessionResponse>
          <BookableSessionId>1</BookableSessionId>
          <Title>Introduction to Symphony</Title>
          <Code />
          <AllowGuests>false</AllowGuests>
          <Capacity>100</Capacity>
          <EndDateTime>2010-01-01T12:30:00</EndDateTime>
          <StartDateTime>2010-01-01T9:30:00</StartDateTime>
          <TaxRate>17.50</TaxRate>
          <GrossPrice>25.00</GrossPrice>
          <WaitingListCapacity xsi:nil="true" />
          <HasWaitingList>true</HasWaitingList>
          <MaximumGuests xsi:nil="true" />
          <SignupCount>3</SignupCount>
          <WaitingListSignupCount>0</WaitingListSignupCount>
          <VenueName>A Venue</VenueName>
          <VenueRoomName>A Room</VenueRoomName>
          <AttendeeTicketTypes>
            <AttendeeTicketTypeResponse>
              <AttendeeTypeId>1</AttendeeTypeId>
              <TicketTypeId>1</TicketTypeId>
              <AttendeeType>Developer</AttendeeType>
              <TicketType>Standard</TicketType>
            </AttendeeTicketTypeResponse>
          </AttendeeTicketTypes>
        </BookableSessionResponse>
      </GetBookableSessionsResult>
    </GetBookableSessionsResponse>
  </soap:Body>
</soap:Envelope>

GetBookingDetails

Parameters

1. bookingId (int)

Return type

BookingDetailsResponse

• BookingId (int)
• BookingReference (string)
• AttendeeCount (int)
• InvoiceUrl (string)
• SecureKey (string)
• LeadAttendeeReference (string)

POST http://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetBookingDetails"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetBookingDetails</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetBookingDetails xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingId>1</bookingId>
    </GetBookingDetails>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetBookingDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetBookingDetailsResult>
        <BookingId>1</BookingId>
        <BookingReference>B1</BookingReference>
        <AttendeeCount>1</AttendeeCount>
        <InvoiceUrl>https://test.pdf</InvoiceUrl>
        <SecureKey>test</SecureKey>
        <LeadAttendeeReference>A0000</LeadAttendeeReference>
      </GetBookingDetailsResult>
    </GetBookingDetailsResponse>
  </soap:Body>
</soap:Envelope>

GetBooking

Parameters

1. bookingId (int)

Return type

BookingResponse

• BookingId (int)
• BookingReference (string)
• BookingStatus (string)
• CreatedDate (DateTime)
• GrossCost (decimal)
• NetCost (decimal)
• Tax (decimal)
• IsTest (boolean)
• AttendeeResponse
  • AttendeeId (int)
  • AttendeeReference (string)
  • AttendeeStatus (string)
  • DateCreated (string)
  • AttendeeType (string)
  • AttendeeTypeId (int)
  • TicketType (string)
  • TicketTypeId (int)
  • Title (int)
  • Forename (int)
  • Surname (int)
  • Organisation (int)
  • Occupation (int)
  • PAName (int)
  • MarketingOptOut (int)
  • Line1 (int)
  • Line2 (int)
  • Line3 (int)
  • Town (int)
  • County (int)
  • Postcode (int)
  • Country (int)
  • Email (int)
  • Telephone (int)
  • Fax (int)
  • Mobile (int)
  • Website (int)
  • IsLeadAttendee (int)
  • Attendance (DateTime[])
  • CustomFieldValueResponse
    • CustomFieldId (int)
    • CustomFieldName (string)
    • Value (string)
  • BookableSessionSignupResponse
    • BookableSessionId (int)
    • BookableSessionName (string)
    • Quantity (int)
    • IsAllocated (boolean)
    • IsOnWaitingList (boolean)
    • GuestDetails (string)
    • StartDateTime (DateTime)
    • EndDateTime (DateTime)
  • ReservationResponse
    • AccommodationRoomTypeNightId (int)
    • Night (DateTime)
    • RoomType (string)
    • Venue (string)
    • Quantity (string)

Notes

This operation returns a list of bookings in chunks of 500. The skip parameter allows you to skip a specified amount of bookings.

Sample Request

POST http://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetBooking"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetBooking</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetBooking xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingId>1</bookingId>
    </GetBooking>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetBookingResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetBookingResult>
        <BookingResponse>
          <BookingId>1</BookingId>
          <BookingReference>B1</BookingReference>
          <BookingStatus>Attending</BookingStatus>
          <CreatedDate>2010-01-01T12:30:00</CreatedDate>
          <GrossCost>0.00</GrossCost>
          <NetCost>0.00</NetCost>
          <Tax>0.00</Tax>
          <IsTest>true</IsTest>
          <Attendees>
            <AttendeeResponse>
              <AttendeeId>1</AttendeeId>
              <AttendeeReference>A00001</AttendeeReference>
              <AttendeeStatus>Attending</AttendeeStatus>
              <DateCreated>2010-01-01T12:30:00</DateCreated>
              <AttendeeType>Developer</AttendeeType>
              <AttendeeTypeId>1</AttendeeTypeId>
              <TicketType>Standard</TicketType>
              <TicketTypeId>1</TicketTypeId>
              <Title>Mr</Title>
              <Forename>John</Forename>
              <Surname>Smith</Surname>
              <Organisation>Symphony</Organisation>
              <Occupation>Developer</Occupation>
              <MarketingOptOut>false</MarketingOptOut>
              <Line1>A house</Line1>
              <Line2>A street</Line2>
              <Line3>A village</Line3>
              <Town>A town</Town>
              <County>A county</County>
              <Postcode>A postcode</Postcode>
              <Country>A country</Country>
              <Email>email@test.co.uk</Email>
              <Telephone>A telephone number</Telephone>
              <IsLeadAttendee>true</IsLeadAttendee>
              <Attendance>
                <dateTime>2010-01-03T00:00:00</dateTime>
                <dateTime>2010-01-04T00:00:00</dateTime>
                <dateTime>2010-01-05T00:00:00</dateTime>
              </Attendance>
              <CustomFieldValues />
              <BookableSessionSignups />
              <Reservations />
            </AttendeeResponse>
          </Attendees>
        </BookingResponse>
      </GetBookingResult>
    </GetBookingResponse>
  </soap:Body>
</soap:Envelope>

GetBookings

Parameters

1. eventId (int)
2. skip (int)

Return type

BookingResponse

• BookingId (int)
• BookingReference (string)
• BookingStatus (string)
• CreatedDate (DateTime)
• GrossCost (decimal)
• NetCost (decimal)
• Tax (decimal)
• IsTest (boolean)
• AttendeeResponse
  • AttendeeId (int)
  • AttendeeReference (string)
  • AttendeeStatus (string)
  • DateCreated (string)
  • AttendeeType (string)
  • AttendeeTypeId (int)
  • TicketType (string)
  • TicketTypeId (int)
  • Title (int)
  • Forename (int)
  • Surname (int)
  • Organisation (int)
  • Occupation (int)
  • PAName (int)
  • MarketingOptOut (int)
  • Line1 (int)
  • Line2 (int)
  • Line3 (int)
  • Town (int)
  • County (int)
  • Postcode (int)
  • Country (int)
  • Email (int)
  • Telephone (int)
  • Fax (int)
  • Mobile (int)
  • Website (int)
  • IsLeadAttendee (int)
  • Attendance (DateTime[])
  • CustomFieldValueResponse
    • CustomFieldId (int)
    • CustomFieldName (string)
    • Value (string)
  • BookableSessionSignupResponse
    • BookableSessionId (int)
    • BookableSessionName (string)
    • Quantity (int)
    • IsAllocated (boolean)
    • IsOnWaitingList (boolean)
    • GuestDetails (string)
    • StartDateTime (DateTime)
    • EndDateTime (DateTime)
  • ReservationResponse
    • AccommodationRoomTypeNightId (int)
    • Night (DateTime)
    • RoomType (string)
    • Venue (string)
    • Quantity (string)

Notes

This operation returns a list of bookings in chunks of 500. The skip parameter allows you to skip a specified amount of bookings.

Sample Request

POST http://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetBookings"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetBookings</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetBookings xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
      <skip>0</skip>
    </GetBookings>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetBookingsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetBookingsResult>
        <BookingResponse>
          <BookingId>1</BookingId>
          <BookingReference>B1</BookingReference>
          <BookingStatus>Attending</BookingStatus>
          <CreatedDate>2010-01-01T12:30:00</CreatedDate>
          <GrossCost>0.00</GrossCost>
          <NetCost>0.00</NetCost>
          <Tax>0.00</Tax>
          <IsTest>true</IsTest>
          <Attendees>
            <AttendeeResponse>
              <AttendeeId>1</AttendeeId>
              <AttendeeReference>A00001</AttendeeReference>
              <AttendeeStatus>Attending</AttendeeStatus>
              <DateCreated>2010-01-01T12:30:00</DateCreated>
              <AttendeeType>Developer</AttendeeType>
              <AttendeeTypeId>1</AttendeeTypeId>
              <TicketType>Standard</TicketType>
              <TicketTypeId>1</TicketTypeId>
              <Title>Mr</Title>
              <Forename>John</Forename>
              <Surname>Smith</Surname>
              <Organisation>Symphony</Organisation>
              <Occupation>Developer</Occupation>
              <MarketingOptOut>false</MarketingOptOut>
              <Line1>A house</Line1>
              <Line2>A street</Line2>
              <Line3>A village</Line3>
              <Town>A town</Town>
              <County>A county</County>
              <Postcode>A postcode</Postcode>
              <Country>A country</Country>
              <Email>email@test.co.uk</Email>
              <Telephone>A telephone number</Telephone>
              <IsLeadAttendee>true</IsLeadAttendee>
              <Attendance>
                <dateTime>2010-01-03T00:00:00</dateTime>
                <dateTime>2010-01-04T00:00:00</dateTime>
                <dateTime>2010-01-05T00:00:00</dateTime>
              </Attendance>
              <CustomFieldValues />
              <BookableSessionSignups />
              <Reservations />
            </AttendeeResponse>
          </Attendees>
        </BookingResponse>
      </GetBookingsResult>
    </GetBookingsResponse>
  </soap:Body>
</soap:Envelope>

GetContact

Parameters

1. email (string)

Return type

ContactResponse

• Title (string)
• Forename (string)
• Surname (string)
• Organisation (string)
• Occupation (string)
• MarketingOptOut (string)
• Line1 (string)
• Line2 (string)
• Line3 (string)
• Town (string)
• County (string)
• Postcode (string)
• Country (string)
• Email (string)
• Telephone (string)
• Fax (string)
• Mobile (string)
• Website (string)
• Reference (string)
• Code (string)
• DateOfBirth (DateTime)

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetContact"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetContact</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetContact xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <email>An email address</email>
    </GetContact>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetContactResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetContactResult>
        <ContactResponse>
          <Title>Mr</Title>
          <Forename>John</Forename>
          <Surname>Smith</Surname>
          <Organisation>Symphony</Organisation>
          <Occupation>Developer</Occupation>
          <MarketingOptOut>false</MarketingOptOut>
          <Line1>A house</Line1>
          <Line2>A street</Line2>
          <Line3>A village</Line3>
          <Town>A town</Town>
          <County>A county</County>
          <Postcode>A postcode</Postcode>
          <Country>A country</Country>
          <Email>email@test.co.uk</Email>
          <Fax>A fax number</Fax>
          <Mobile>A mobile number</Mobile>
          <Website>A website</Website>
          <Reference>Reference</Reference>
          <Code>Code</Code>
          <DateOfBirth>Date of birth</DateOfBirth>
        </ContactResponse>
      </GetContactResult>
    </GetContactResponse>
  </soap:Body>
</soap:Envelope>

GetContacts

Parameters

1. skip (int)

Return type

ContactListResponse

• TotalContacts (int)
• ContactResponse
  • Title (string)
  • Forename (string)
  • Surname (string)
  • Organisation (string)
  • Occupation (string)
  • MarketingOptOut (string)
  • Line1 (string)
  • Line2 (string)
  • Line3 (string)
  • Town (string)
  • County (string)
  • Postcode (string)
  • Country (string)
  • Email (string)
  • Telephone (string)
  • Fax (string)
  • Mobile (string)
  • Website (string)
  • Reference (string)
  • Code (string)
  • DateOfBirth (DateTime)

Notes

This operation returns a list of contacts in chunks of 500. The skip parameter allows you to skip a specified amount of contacts.

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetContacts"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetContacts</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetContacts xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <skip>0</skip>
    </GetContacts>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetContactsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetContactsResult>
        <TotalContacts>1</TotalContacts>
        <Contacts>
          <ContactResponse>
            <Title>Mr</Title>
            <Forename>John</Forename>
            <Surname>Smith</Surname>
            <Organisation>Symphony</Organisation>
            <Occupation>Developer</Occupation>
            <MarketingOptOut>false</MarketingOptOut>
            <Line1>A house</Line1>
            <Line2>A street</Line2>
            <Line3>A village</Line3>
            <Town>A town</Town>
            <County>A county</County>
            <Postcode>A postcode</Postcode>
            <Country>A country</Country>
            <Email>email@test.co.uk</Email>
            <Fax>A fax number</Fax>
            <Mobile>A mobile number</Mobile>
            <Website>A website</Website>
            <Reference>Reference</Reference>
            <Code>Code</Code>
            <DateOfBirth>Date of birth</DateOfBirth>
          </ContactResponse>
        </Contacts>
      </GetContactsResult>
    </GetContactsResponse>
  </soap:Body>
</soap:Envelope>

GetCountries

Parameters

None

Return type

CountryResponse

• Name (string)
• Key (string)

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetCountries"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetCountries</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetCountries xmlns="https://developer.sym-online.com/API/1_0/SOAP/" />
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetCountriesResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetCountriesResult>
        <CountryResponse>
          <Name>United Kingdom</Name>
          <Key>United Kingdom</Key>
        </CountryResponse>
      </GetCountriesResult>
    </GetCountriesResponse>
  </soap:Body>
</soap:Envelope>

GetCustomFields

Parameters

1. eventId (int)

Return type

• CustomFieldResponse
  • CustomFieldId (int)
  • Name (string)
  • Type (string)
  • Values (list of strings)

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetCustomFields"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetCustomFields</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetCustomFields xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetCustomFields>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetCustomFieldsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetCustomFieldsResult>
        <CustomFieldResponse>
          <CustomFieldId>1</CustomFieldId>
          <Name>What is your job title?</Name>
          <Type>Single Selection</Type>
          <Values>
            <string>Senior Developer</string>
            <string>Developer</string>
            <string>Junior Developer</string>
            <string>Director</string>
            <string>Account Manager</string>
            <string>Account Executive</string>
          </Values>
        </CustomFieldResponse>
      </GetCustomFieldsResult>
    </GetCustomFieldsResponse>
  </soap:Body>
</soap:Envelope>

GetDays

Parameters

1. eventId (int)

Return type

• EventDayResponse
  • EventDayId (int)
  • DateTime (DateTime)
  • Capacity (int)
  • HasCapacityLimits (boolean)
  • AttendeeCount (int)

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetDays"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetDays</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetDays xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetDays>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetDaysResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetDaysResult>
        <EventDayResponse>
          <EventDayId>1</EventDayId>
          <Date>2010-01-01T00:00:00</Date>
          <Capacity>20</Capacity>
          <HasCapacityLimits>true</HasCapacityLimits>
          <AttendeeCount>15</AttendeeCount>
        </EventDayResponse>
      </GetDaysResult>
    </GetDaysResponse>
  </soap:Body>
</soap:Envelope>

GetEventDetails

Parameters

1. eventId (int)

Return type

• EventDetailsResponse
  • Code (string)
  • Description (string)
  • EndDate (Datetime)
  • Capacity (int)
  • HasCapacityLimits (boolean)
  • HelplineEmail (string)
  • HelplineName (string)
  • HelplineTelephone (string)
  • IsArchived (boolean)
  • SignupEndDate (Datetime)
  • SignupStartDate (Datetime)
  • StartDate (Datetime)
  • Title (string)
  • AttendeeCount (int)

Sample Request

POST http://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetEventDetails"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetEventDetails</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetEventDetails xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetEventDetails>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetEventDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetEventDetailsResult>
        <Code />
        <Description>Event description</Description>
        <EndDate>2010-01-08T00:00:00</EndDate>
        <Capacity>100</Capacity>
        <HasCapacityLimits>true</HasCapacityLimits>
        <HelplineEmail>email@test.co.uk</HelplineEmail>
        <HelplineName>Administrator</HelplineName>
        <HelplineTelephone>A telephone number</HelplineTelephone>
        <IsArchived>false</IsArchived>
        <SignupEndDate>2010-01-05T00:00:00</SignupEndDate>
        <SignupStartDate>2010-01-01T00:00:00</SignupStartDate>
        <StartDate>2010-01-06T00:00:00</StartDate>
        <Title>Event title</Title>
        <IsFull>false</IsFull>
        <AttendeeCount>17</AttendeeCount>
      </GetEventDetailsResult>
    </GetEventDetailsResponse>
  </soap:Body>
</soap:Envelope>

GetInvoiceDetails

Parameters

1. secureKey (string)

Return type

• InvoiceDetailsResponse
  • InvoiceReference (string)
  • InvoiceUrl (string)
  • TotalGross (decimal)
  • TotalNet (decimal)
  • PaymentStatus (string)
  • DateCreated (DateTime)
  • Tax (decimal)
  • IsCreditNote (bool)
  • BookingReference (string)
  • InvoicePaymentResponse
    • PaymentDate (DateTime)
    • Amount (decimal)
    • Status (string)

Notes

This operation returns the invoice details that correspond to the provided invoice secure key.

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetInvoiceDetails"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetInvoices</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetInvoiceDetails xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <secureKey>abc</secureKey>
    </GetInvoiceDetails>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetInvoiceDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <InvoiceDetailsResponse>
        <InvoiceReference>Inv000001</InvoiceReference>
        <InvoiceUrl>https://user.sym-online.com/invoice/abc.pdf</InvoiceUrl>
        <TotalGross>200.00</TotalGross>
        <TotalNet>165.00</TotalNet>
        <PaymentStatus>Paid</PaymentStatus>
        <DateCreated>1/1/2010</DateCreated>
        <Tax>35.00</Tax>
        <IsCreditNote>false</IsCreditNote>
        <BookingReference>B1</BookingReference>
        <InvoicePaymentResponse>
          <PaymentDate>1/1/2010</PaymentDate>
          <Amount>200.00</Amount>
          <Status>Success</Status>
        </InvoicePaymentResponse>
      </InvoiceDetailsResponse>
    </GetInvoiceDetailsResponse>
  </soap:Body>
</soap:Envelope>

GetInvoices

Parameters

1. eventId (int)
2. skip (int)

Return type

• InvoiceResponse
  • InvoiceReference (string)
  • DateCreated (string)
  • Net (decimal)
  • Gross (decimal)
  • Tax (decimal)
  • IsCreditNote (boolean)
  • BookingReference (string)

Notes

This operation returns a list of invoices in chunks of 500. The skip parameter allows you to skip a specified amount of invoices.

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetInvoices"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetInvoices</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetInvoices xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
      <skip>0</skip>
    </GetInvoices>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetInvoicesResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Invoice>
        <InvoiceReference>Inv000001</InvoiceReference>
        <DateCreated>1/1/2010</DateCreated>
        <Net>165.00</Net>
        <Gross>200.00</Gross>
        <Tax>35.00</Tax>
        <IsCreditNote>false</IsCreditNote>
        <BookingReference>B1</BookingReference>
      </Invoice>
    </GetInvoicesResponse>
  </soap:Body>
</soap:Envelope>

GetTicketTypes

Parameters

1. eventId (int)

Return type

TicketTypeResponse

• TicketTypeId (int)
• Name (string)
• Capacity (int)
• GrossPrice (decimal)
• TaxRate (decimal)
• AttendeeCount (int)
• NumberOfDaysValid (int)
• IsOpen (boolean)
• AttendeeTypeResponse
  • AttendeeTypeId (int)
  • Name (string)
• AvailabilityStartDate (DateTime)
• AvailabilityEndDate (DateTime)
• TicketAttendanceTypeResponse
  • Id (int)
  • Name (string)
• TicketTypeDayResponse
  • Date (DateTime)

Notes

Attendee count is the total number of attendees that have signed up to the ticket type.

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetTicketTypes"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>GetTicketTypes</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetTicketTypes xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>1</eventId>
    </GetTicketTypes>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetTicketTypesResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetTicketTypesResult>
        <TicketTypeResponse>
          <TicketTypeId>1</TicketTypeId>
          <Name>Standard</Name>
          <Capacity>150</Capacity>
          <GrossPrice>200.00000</GrossPrice>
          <TaxRate>17.50000</TaxRate>
          <AttendeeTypes>
            <AttendeeTypeResponse>
              <AttendeeTypeId>1</AttendeeTypeId>
              <Name>Developer</Name>
            </AttendeeTypeResponse>
            <AttendeeTypeResponse>
              <AttendeeTypeId>2</AttendeeTypeId>
              <Name>Director</Name>
            </AttendeeTypeResponse>
          </AttendeeTypes>
          <AttendeeCount>100</AttendeeCount>
          <NumberOfDaysValid xsi:nil="true" />
          <IsOpen>false</IsOpen>
          <AvailabilityStartDate>2010-01-01T00:00:00</AvailabilityStartDate>
          <AvailabilityEndDate>2010-02-01T00:00:00</AvailabilityEndDate>
          <AttendanceType>
            <TicketAttendanceTypeResponse>
              <Id>1</Id>
              <Name>All days</Name>            
            </TicketAttendanceTypeResponse>
          </AttendanceType>
          <TicketTypeDays>
            <TicketTypeDayResponse>
              <Date>2010-01-01T00:00:00</Date>
            </TicketTypeDayResponse>
          </TicketTypeDays>
        </TicketTypeResponse>
      </GetTicketTypesResult>
    </GetTicketTypesResponse>
  </soap:Body>
</soap:Envelope>

SubmitBooking

Parameters

1. EventId (int)
2. Attendee Request
   • AttendeeTypeId (int)
   • TicketTypeId (int)
   • Title (string)
   • Forename (string)
   • Surname (string)
   • Organisation (string)
   • Occupation (string)
   • PAName (string)
   • MarketingOptOut (boolean)
   • Line1 (string)
   • Line2 (string)
   • Line3 (string)
   • Town (string)
   • County (string)
   • Postcode (string)
   • Country (string)
   • Email (string)
   • Telephone (string)
   • Fax (string)
   • Mobile (string)
   • Website (string)
   • IsLeadAttendee (boolean)
   • Attendance
     • DateTime (DateTime[])
   • CustomFieldValueRequest
     • CustomFieldId (int)
     • Value (string)
   • BookableSessionSignupRequest
     • BookableSessionId (int)
     • Quantity (int)
     • AddToWaitingList (boolean)
     • GuestDetails (string)
   • ReservationRequest
     • AccommodationRoomTypeNightId (int)
     • Quantity (int)
   • BillingAddress
     • AddressId (int)
     • Line1 (string)
     • Line2 (string)
     • Line3 (string)
     • Town (string)
     • County (string)
     • Postcode (string)
     • Country (string)
     • Email (string)
     • Telephone (string)
     • Mobile (string)
     • Website (string)
3. PurchaseOrderNumber (string)
4. DiscountCodesUsed (string[])
5. ConfirmationUrl (string)
6. IsTest (boolean)

Return type

None

Notes

SubmitBooking does not check capacities
Default quantity on session signup and reservations is 0

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/SubmitBooking"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>SubmitBooking</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <SubmitBooking xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <eventId>eventId</eventId>
      <attendees>
        <AttendeeRequest>
          <AttendeeTypeId>1</AttendeeTypeId>
          <TicketTypeId>1</TicketTypeId>
          <Title>Mr</Title>
          <Forename>John</Forename>
          <Surname>Smith</Surname>
          <Organisation>Symphony</Organisation>
          <Occupation>Developer</Occupation>
          <PAName>A pa</PAName>
          <MarketingOptOut>false</MarketingOptOut>
          <Line1>A house</Line1>
          <Line2>A street</Line2>
          <Line3>A village</Line3>
          <Town>A town</Town>
          <County>A county</County>
          <Postcode>A postcode</Postcode>
          <Country>A country</Country>
          <Email>email@test.co.uk</Email>
          <Telephone>A telephone number</Telephone>
          <Fax>A fax number</Fax>
          <Mobile>A mobile number</Mobile>
          <Website>A website</Website>
          <IsLeadAttendee>true</IsLeadAttendee>
          <Attendance>
            <dateTime>2010-01-03T00:00:00</dateTime>
            <dateTime>2010-01-04T00:00:00</dateTime>
            <dateTime>2010-01-05T00:00:00</dateTime>
          </Attendance>
          <CustomFieldValues>
            <CustomFieldValueRequest>
              <CustomFieldId>1</CustomFieldId>
              <Value>Developer</Value>
            </CustomFieldValueRequest>
          </CustomFieldValues>
          <BookableSessionSignups>
            <BookableSessionSignupRequest>
              <BookableSessionId>1</BookableSessionId>
              <Quantity>1</Quantity>
              <AddToWaitingList>false</AddToWaitingList>
              <GuestDetails>Jane Smith is coming with me</GuestDetails>
            </BookableSessionSignupRequest>
          </BookableSessionSignups>
          <Reservations>
            <ReservationRequest>
              <ReservationId>1</ReservationId>
              <AccommodationRoomTypeNightId>1</AccommodationRoomTypeNightId>
              <Quantity>1</Quantity>
            </ReservationRequest>
          </Reservations>
        </AttendeeRequest>
      </attendees>
      <billingAddress>
        <AddressId xsi:nil="true" />
        <Line1>A house</Line1>
        <Line2>A street</Line2>
        <Line3>A village</Line3>
        <Town>A town</Town>
        <County>A county</County>
        <Postcode>A postcode</Postcode>
        <Country>A country</Country>
        <Email>email@test.co.uk</Email>
        <Telephone>A telephone number</Telephone>
        <Mobile>A mobile number</Mobile>
        <Website>A website</Website>
      </billingAddress>
      <purchaseOrderNumber>100</purchaseOrderNumber>
      <discountCodesUsed>
        <string>Code0035</string>
      </discountCodesUsed>
      <confirmationUrl>https://www.test.com/returnpage.htm</confirmationUrl>
      <isTest>true</isTest>
    </SubmitBooking>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <SubmitBookingResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <SubmitBookingResult>561</SubmitBookingResult>
    </SubmitBookingResponse>
  </soap:Body>
</soap:Envelope>

SubmitContact

Parameters

1. email (string)
2. title (string)
3. forename (string)
4. surname (string)
5. organisation (string)
6. occupation (string)
7. paName (string)
8. marketingOptOut (string)
9. line1 (string)
10. line2 (string)
11. line3 (string)
12. town (string)
13. county (string)
14. postcode (string)
15. country (string)
16. telephone (string)
17. fax (string)
18. mobile (string)
19. website (string)
20. reference (string)
21. code (string)

Return type

None

Notes

Contacts must have a unique email address. If a contact with the email address specified exists the contact details will be updated if not a new contact will be create.

Sample Request

POST https://developer.sym-online.com/API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/SubmitContact"
Host: developer.sym-online.com

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>2010-01-01T12:30:00.000Z</Timestamp>
      <Operation>SubmitContact</Operation>
      <Signature>ABC</Signature>
      <APIKey>XYZ</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <SubmitContact xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <email>email</email>
      <title>title</title>
      <forename>forename</forename>
      <surname>surname</surname>
      <organisation>organisation</organisation>
      <occupation>occupation</occupation>
      <paName>paName</paName>
      <marketingOptOut>marketingOptOut</marketingOptOut>
      <line1>line1</line1>
      <line2>line2</line2>
      <line3>line3</line3>
      <town>town</town>
      <county>county</county>
      <postcode>postcode</postcode>
      <country>country</country>
      <telephone>telephone</telephone>
      <fax>fax</fax>
      <mobile>mobile</mobile>
      <website>website</website>
      <reference>website</reference>
      <code>website</code>
    </SubmitContact>
  </soap:Body>
</soap:Envelope>

Sample Response

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <SubmitContactResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/" />
  </soap:Body>
</soap:Envelope>