Symphony API V1.0
API V1.0 for integration with Symphony.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAttendeesToBooking
This method can be used to add attendees to an existing booking -
AddAttendeesToBookingAndUpdateAttendee
This method can be used to add attendees to an existing booking as well as updating the main attendee -
AuthenticateAbstractsUser
This method can be used to check that a username password combination is valid -
CancelAttendee
This method can be used to cancel an attendee -
CancelBooking
This method can be used to cancel a booking -
CancelSeatsReservation
This method can be used to Cancel a bulk seat reservation -
ChangeAttendeePasswordEmailRequest
This method can be used to send a 'change password' email request -
ChangeBookingStatus
This method can be used to change the booking status of an existing one person booking associated with a global contact -
ChangePasswordEmailRequest
This method can be used to send a 'change password' email request -
ChangePasswordEmailRequestDefault
This method can be used to send a 'change password' email request -
CheckAttendeeLogOn
This method can be used to check if an attendee login is correct -
CheckContactExists
This method checks if a global contact exists with the specified email address -
CheckEmailAddress
This method can be used to check if an email address exists for this symphony Account -
CheckIsRegisteredForEvent
This method checks if the client is already registered for an event -
CheckIsRegisteredForEvent2
This method checks if the contact is already registered for an event, with the option to specify the attendee 'StatusType' or if the attendee 'IsAttending' -
CheckLogOn
This method can be used to check if a contact login is correct -
EventProfileSearch
This method can be used to run a dynamic query and return a list of events based on the search parameters -
GenerateTokenForContact
This method can be used to generate a unique token that can later be used with the VerifyTokenForContact method. Each call to this method will delete all other tokens for this 'contactId' and 'tokenType' combination. Options for 'tokenType' are [ContactRegistration] -
GetAccommodation
This method can be used to retrieve all available accommodation for an event -
GetApprovedContacts
This method can be used to retrieve all contacts with a registration status APPROVED -
GetAttendeeByAttendeeId
This method can be used to get an attendee by a unique attendee id -
GetAttendeeStatuses
This method can be used to get all the attendee statuses for an event -
GetAttendeeTypes
This method can be used to retrieve all attendee types for an event -
GetAttendeesByContactEmail
This method can be used to retrieve the details of all a contact's event bookings -
GetAttendeesByEventSurname
This method can be used to retrieve the details of attendee's based on the search criteria specified -
GetAttendeesBySearchCriteria
This method can be used to retrieve the details of attendee's based on the search criteria specified -
GetAttendeesExtByEventExternalSystemId
This method returns attendees for a particular event external system id -
GetAttendeesExtByEventId
This method returns attendees for a particular event id -
GetAttendeesExtByRoadshowId
This method returns attendees for a particular event roadshow id -
GetBookableSessions
This method can be used to retrieve all bookable sessions for an event -
GetBooking
This method retrieves a booking -
GetBookingDetails
This method retrieves simple booking details -
GetBookingForms
This method can be used to retrieve booking form details in the Symphony system -
GetBookingRealexDetails
This method retrieves the most recent unpaid invoice for a chosen booking -
GetBookingStatuses
This method can be used to get all the booking statuses for an event -
GetBookings
This method can be used to retrieve all bookings for an event -
GetBookingsBatch
This method can be used to retrieve all bookings for an event in batches for paging results -
GetBookingsByContactId
This method can be used to retrieve all bookings for an event where the lead attendee has the specified contact ID -
GetBookingsByEmail
This method can be used to retrieve all bookings for an event where the lead attendee has the specified email address -
GetBookingsCount
This method can be used to retrieve the total number of bookings for an event -
GetCalendarAttendeesForEvent
This method can be used to retrieve information about an event's attendees -
GetCalendarEventsByDateRange
This method can be used to retrieve information about a company's events between a range of dates -
GetCalendarInviteesForEvent
This method can be used to retrieve information about an event's invitees -
GetCalendarInviteesForEventWithLimit
This method can be used to retrieve information about an event's invitees by skipping a set amount and taking a set amount -
GetClientCompanyList
This method can be used to retrieve a list of all client companies -
GetClientCompanyProfileList
This method can be used to get a list of profile types with their associated profile values. Can filter by Client Company -
GetContact
This method can be used to retrieve a contact from the Symphony system -
GetContact2
This method can be used to retrieve a contact for use with login from the Symphony system -
GetContactById
This method can be used to retrieve a contact from the Symphony system -
GetContactEventBookings
This method can be used to retrieve all bookings for an event for a particular contact -
GetContactEventHistory
This method can be used to get the events a contact is attending -
GetContactEventHistory2
This method can be used to get the events a contact is attending -
GetContactEventHistory3
This method can be used to get the events a contact is attending, with extended event information -
GetContactEventHistoryIds
This method can be used to get the event id's for all the events a contact is attending -
GetContacts
This method can be used to retrieve all contacts -
GetCountries
This method can be used to retrieve all countries in the Symphony system -
GetCustomFields
This method can be used to retrieve all custom fields for an event -
GetDays
This method can be used to retrieve all available dates within an event -
GetEventAttendance
This method can be used to retrieve how many delegates are checked into an event and how many aren't -
GetEventAttendees
This method can be used to retrieve the all the attendees for a specific event -
GetEventDetails
This method can be used to retrieve details about an event -
GetEventDetails2
This method can be used to retrieve details about an event with extended set of returned values -
GetEventDetails3
This method can be used to retrieve details about an event with extended set of returned values -
GetEventDetails4
This method can be used to retrieve details about an event with extended set of returned values, includes roadshowId -
GetEventDetails5
This method can be used to retrieve details about an event with extended set of returned values, includes roadshowId, Status, SubClientCompanyName and LastUpdatedDate fields -
GetEventDetails6
This method can be used to retrieve details about an event with extended set of returned values, includes roadshowId, Status, SubClientCompanyName and LastUpdatedDate fields and Event Profile Values -
GetEventDetails7
This method can be used to retrieve details about an event with extended set of returned values, includes roadshowId, Status, SubClientCompanyName and LastUpdatedDate fields and Event Profile Values -
GetEventDetailsClient
This method can be used to retrieve details about an event with client included -
GetEventDetailsClientWithStatus
This method can be used to retrieve details about an event with client included -
GetEventExtByDateRange
This method can be used to retrieve extended event information between two dates -
GetEventExtDetailsByDateRange
This method can be used to retrieve extended event information between two dates -
GetEventPaymentTypes
This method can be used to retrieve all payment types for an event in the Symphony system -
GetEventSpeakers
This method can be used to get all speakers for a given event -
GetEventTypeList
This method can be used to retrieve a list of all event types -
GetEvents
This method can be used to retrieve an event in the Symphony system -
GetEventsByContactEmail
This method can be used to retrieve basic details of all the events that a contact is booked on -
GetEventsByContactId
This method returns all events associated with a contact -
GetEventsBySpeakerEmail
This method retrieves all events associated with a speaker -
GetEventsForContact
This method can be used to retrieve basic details of all the events that a contact is booked on -
GetEventsForUser
This method can be used to retrieve basic details of all the events available to the specified user -
GetExtBookings
This method can be used to retrieve all bookings for an event with extended attendee information -
GetExtBookingsBatch
This method can be used to retrieve all bookings for an event with extended info, in batches for paging results -
GetExtEvents
This method can be used to retrieve extended information about an event in the Symphony system -
GetExtEventsByRoadshowId
This method can be used to retrieve extended information about an event in the Symphony system -
GetExtEventsDetails
This method can be used to retrieve extended information about a list of events in the Symphony system -
GetExtEventsDetails2
This method can be used to retrieve extended information about a list of events based on search criteria in the Symphony system -
GetExtEventsDetails3
This method can be used to retrieve extended information about a list of 'Current' events based on search criteria in the Symphony system, with result pagination, sub-client company and profile values search -
GetExtEventsDetails4
This method can be used to retrieve extended information about a list of 'Current' and 'Cancelled' events based on search criteria in the Symphony system, with result pagination, sub-client company and profile values search -
GetExtEventsDetails5
This method can be used to retrieve extended information about a list of 'Current' events based on search criteria in the Symphony system, with result pagination, sub-client company and profile values search -
GetExtEventsDetails6
This method can be used to retrieve extended information about a list of 'Current' events based on search criteria in the Symphony system, with result pagination, sub-client company and profile values search -
GetHeldReservationsForShow
This method can be used to retrieve all held seat reservations for a show -
GetInvoiceDetails
This method can be used to retrieve the invoice details for the provided secure key -
GetInvoices
This method can be used to retrieve all invoices for an event -
GetPasswordTokenByToken
This method can be used to retreive a password token using the unique token -
GetProfileList
This method can be used to get a list of profile types with their associated profile values -
GetReservations
This method can be used to retrieve all seat reservations for a contact -
GetReservationsForShow
This method can be used to retrieve all seat reservations for a show -
GetRoadshows
This method can be used to retrieve basic info for a client's roadshows -
GetShowPerformances
This method can be used to retrieve all ShowPerformances and SKUs for a Show -
GetShows
This method can be used to retrieve all Shows and ShowPerformances for a clinet -
GetSpeakerEventsDetails
This method can be used to get all events a speaker is attending -
GetSpeakersGlobal
This method can be used to get all speakers for a given client -
GetSpeakersforEvent
This method retrieves all speakers for an event -
GetSpeakersforSeries
This method returns all speakers associated with an event series value -
GetSubClientCompanyList
This method can be used to retrieve a list of all non-universal sub-client companies -
GetSubmissionDetail
This method can be used to retrieve an abstract submission given a booking reference -
GetSubmissionsForEvent
This method can be used to retrieve all abstract submissions for an event -
GetSubmissionsForEvent2
This method can be used to retrieve all abstract submissions for an event, with abstract theme -
GetTicketTypeById
This method can be used to retrieve a single ticket type for an event -
GetTicketTypeInviteText
This method can be used to retrieve all ticket types for an event -
GetTicketTypes
This method can be used to retrieve all ticket types for an event -
GetTicketTypes2
This method can be used to retrieve all ticket types for an event, with ExternalSite and MinAge populated -
GetTicketTypesByRoadshowId
This method can be used to retrieve all ticket types for events under a roadshow -
GetTicketTypesForEventWithRoadshow
This method can be used to retrieve all ticket types for an event that has a roadshow attached -
GetVenue
This method can be used to retrieve a venue in the Symphony system -
GetWebsitePageContent
This method retrieves website page content -
HKChangePasswordEmailRequest
This method can be used to send a 'change password' email request -
IsEventCapacityLimitReached
This method can be used to find out if an event has reached capacity -
RecordPayment
This method can be used to record a payment in the Symphony system -
SetContactExternalSystemId
This method can be used to update a contact's externalSystemId -
SetEventExternalSystemId
This method can be used to update an event's externalSystemId -
SubmitAbstractComment
This method can be used to submit an abstract comment -
SubmitAbstractVote
This method can be used to submit an abstract vote -
SubmitAttendeePassword
This method can be used to get change an attendees password, using a unique attendee id -
SubmitBooking
This method can be used to submit a booking -
SubmitBooking2
This method can be used to submit a booking, uses a different attendee request object with additional fields. Also contains additional fields for the booking table. -
SubmitBookingWithGlobalContact
This method can be used to submit a booking and attach a global contact to an attendee -
SubmitContact
This method can be used to add a contact -
SubmitContact2
This method can be used to add a contact with a password, registration status, profile values, social media links and biographies -
SubmitContact3
This method can be used to add a contact with a password, registration status, profile values, social media links, biographies, gender and department -
SubmitPassword
This method can be used to change a contact password -
SubmitSeatsReservation
This method can be used to Submit a bulk seat reservation -
SubmitSimpleBooking
This method can be used to create a simple one person booking using an existing global contact. This will also send any BookingUpdated trigger emails. -
SubmitSimpleBooking2
This method can be used to create a simple one person booking using an existing global contact. This will also send any BookingCompleted trigger emails. -
SubmitSimpleBookingWithBookingStatus
This method can be used to create a simple one person booking with a specific status, using an existing global contact. This will also send any BookingUpdated trigger emails. -
SubmitSimpleBookingWithBookingStatus2
This method can be used to create a simple one person booking with a specific status, using an existing global contact. This will also send any trigger emails based on the bookingStatusId passed in. -
UpdateAttendeeAttendedStatus
This method can be used to update the attendee's attended status -
UpdateAttendeeCheckIn
This method can be used to update the attendee's attended status and check them in to an event -
UpdateContact
This method can be used to update an existing contact -
UpdateContact2
This method can be used to update an existing contact, submitting only basic details -
UpdateContactRegStatus
This method can be used to update the contacts reg_status -
VerifyTokenForContact
This method can be used to validate a unique token generated by the GenerateTokenForContact method. If 'IsSingleUse' is true (set when generating the token) then the token will be invalidated after the first use of this endpoint. Options for 'tokenType' are [ContactRegistration]