Symphony API V1.0
Click here for a complete list of operations.
GetEventDetails3
This method can be used to retrieve details about an event with extended set of returned values
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/GetEventDetails3"
<?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>
<GetEventDetails3 xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<eventId>int</eventId>
</GetEventDetails3>
</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>
<GetEventDetails3Response xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<GetEventDetails3Result>
<EventId>int</EventId>
<EventWaitingListEnabled>boolean</EventWaitingListEnabled>
<Code>string</Code>
<Description>string</Description>
<MediumDescription>string</MediumDescription>
<LongDescription>string</LongDescription>
<EndDate>dateTime</EndDate>
<Capacity>int</Capacity>
<HasCapacityLimits>boolean</HasCapacityLimits>
<HelplineEmail>string</HelplineEmail>
<HelplineName>string</HelplineName>
<HelplineTelephone>string</HelplineTelephone>
<IsArchived>boolean</IsArchived>
<SignupEndDate>dateTime</SignupEndDate>
<SignupStartDate>dateTime</SignupStartDate>
<StartDate>dateTime</StartDate>
<Title>string</Title>
<AttendeeCount>int</AttendeeCount>
<AttendeeWaitingListCount>int</AttendeeWaitingListCount>
<AttendeeCancelledCount>int</AttendeeCancelledCount>
<Venues>
<int>int</int>
<int>int</int>
</Venues>
<ThirdPartyEvent>boolean</ThirdPartyEvent>
<ExternalURL>string</ExternalURL>
<ExternalURLPwd>string</ExternalURLPwd>
<Code_Room>string</Code_Room>
<ClientCompanyName>string</ClientCompanyName>
<ImageLink>string</ImageLink>
<ImageThumbLink>string</ImageThumbLink>
<Code_Type>string</Code_Type>
<Code_Series>string</Code_Series>
<CPDValue>int</CPDValue>
<DefaultBookingFormName>string</DefaultBookingFormName>
<DefaultBookingFormUrl>string</DefaultBookingFormUrl>
<DefaultWebsiteID>int</DefaultWebsiteID>
<DefaultWebsiteName>string</DefaultWebsiteName>
<DefaultWebsitePageFriendlyName>string</DefaultWebsitePageFriendlyName>
<StartTime>dateTime</StartTime>
<EndTime>dateTime</EndTime>
<Location>string</Location>
<Organisers>string</Organisers>
<Collaborators>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
</Collaborators>
<Links>
<string>string</string>
<string>string</string>
</Links>
</GetEventDetails3Result>
</GetEventDetails3Response>
</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>
<GetEventDetails3 xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<eventId>int</eventId>
</GetEventDetails3>
</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>
<GetEventDetails3Response xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<GetEventDetails3Result>
<EventId>int</EventId>
<EventWaitingListEnabled>boolean</EventWaitingListEnabled>
<Code>string</Code>
<Description>string</Description>
<MediumDescription>string</MediumDescription>
<LongDescription>string</LongDescription>
<EndDate>dateTime</EndDate>
<Capacity>int</Capacity>
<HasCapacityLimits>boolean</HasCapacityLimits>
<HelplineEmail>string</HelplineEmail>
<HelplineName>string</HelplineName>
<HelplineTelephone>string</HelplineTelephone>
<IsArchived>boolean</IsArchived>
<SignupEndDate>dateTime</SignupEndDate>
<SignupStartDate>dateTime</SignupStartDate>
<StartDate>dateTime</StartDate>
<Title>string</Title>
<AttendeeCount>int</AttendeeCount>
<AttendeeWaitingListCount>int</AttendeeWaitingListCount>
<AttendeeCancelledCount>int</AttendeeCancelledCount>
<Venues>
<int>int</int>
<int>int</int>
</Venues>
<ThirdPartyEvent>boolean</ThirdPartyEvent>
<ExternalURL>string</ExternalURL>
<ExternalURLPwd>string</ExternalURLPwd>
<Code_Room>string</Code_Room>
<ClientCompanyName>string</ClientCompanyName>
<ImageLink>string</ImageLink>
<ImageThumbLink>string</ImageThumbLink>
<Code_Type>string</Code_Type>
<Code_Series>string</Code_Series>
<CPDValue>int</CPDValue>
<DefaultBookingFormName>string</DefaultBookingFormName>
<DefaultBookingFormUrl>string</DefaultBookingFormUrl>
<DefaultWebsiteID>int</DefaultWebsiteID>
<DefaultWebsiteName>string</DefaultWebsiteName>
<DefaultWebsitePageFriendlyName>string</DefaultWebsitePageFriendlyName>
<StartTime>dateTime</StartTime>
<EndTime>dateTime</EndTime>
<Location>string</Location>
<Organisers>string</Organisers>
<Collaborators>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
</Collaborators>
<Links>
<string>string</string>
<string>string</string>
</Links>
</GetEventDetails3Result>
</GetEventDetails3Response>
</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/GetEventDetails3?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"?>
<EventDetailsResponse3 xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<EventId>int</EventId>
<EventWaitingListEnabled>boolean</EventWaitingListEnabled>
<Code>string</Code>
<Description>string</Description>
<MediumDescription>string</MediumDescription>
<LongDescription>string</LongDescription>
<EndDate>dateTime</EndDate>
<Capacity>int</Capacity>
<HasCapacityLimits>boolean</HasCapacityLimits>
<HelplineEmail>string</HelplineEmail>
<HelplineName>string</HelplineName>
<HelplineTelephone>string</HelplineTelephone>
<IsArchived>boolean</IsArchived>
<SignupEndDate>dateTime</SignupEndDate>
<SignupStartDate>dateTime</SignupStartDate>
<StartDate>dateTime</StartDate>
<Title>string</Title>
<AttendeeCount>int</AttendeeCount>
<AttendeeWaitingListCount>int</AttendeeWaitingListCount>
<AttendeeCancelledCount>int</AttendeeCancelledCount>
<Venues>
<int>int</int>
<int>int</int>
</Venues>
<ThirdPartyEvent>boolean</ThirdPartyEvent>
<ExternalURL>string</ExternalURL>
<ExternalURLPwd>string</ExternalURLPwd>
<Code_Room>string</Code_Room>
<ClientCompanyName>string</ClientCompanyName>
<ImageLink>string</ImageLink>
<ImageThumbLink>string</ImageThumbLink>
<Code_Type>string</Code_Type>
<Code_Series>string</Code_Series>
<CPDValue>int</CPDValue>
<DefaultBookingFormName>string</DefaultBookingFormName>
<DefaultBookingFormUrl>string</DefaultBookingFormUrl>
<DefaultWebsiteID>int</DefaultWebsiteID>
<DefaultWebsiteName>string</DefaultWebsiteName>
<DefaultWebsitePageFriendlyName>string</DefaultWebsitePageFriendlyName>
<StartTime>dateTime</StartTime>
<EndTime>dateTime</EndTime>
<Location>string</Location>
<Organisers>string</Organisers>
<Collaborators>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
</Collaborators>
<Links>
<string>string</string>
<string>string</string>
</Links>
</EventDetailsResponse3>
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/GetEventDetails3 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"?>
<EventDetailsResponse3 xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<EventId>int</EventId>
<EventWaitingListEnabled>boolean</EventWaitingListEnabled>
<Code>string</Code>
<Description>string</Description>
<MediumDescription>string</MediumDescription>
<LongDescription>string</LongDescription>
<EndDate>dateTime</EndDate>
<Capacity>int</Capacity>
<HasCapacityLimits>boolean</HasCapacityLimits>
<HelplineEmail>string</HelplineEmail>
<HelplineName>string</HelplineName>
<HelplineTelephone>string</HelplineTelephone>
<IsArchived>boolean</IsArchived>
<SignupEndDate>dateTime</SignupEndDate>
<SignupStartDate>dateTime</SignupStartDate>
<StartDate>dateTime</StartDate>
<Title>string</Title>
<AttendeeCount>int</AttendeeCount>
<AttendeeWaitingListCount>int</AttendeeWaitingListCount>
<AttendeeCancelledCount>int</AttendeeCancelledCount>
<Venues>
<int>int</int>
<int>int</int>
</Venues>
<ThirdPartyEvent>boolean</ThirdPartyEvent>
<ExternalURL>string</ExternalURL>
<ExternalURLPwd>string</ExternalURLPwd>
<Code_Room>string</Code_Room>
<ClientCompanyName>string</ClientCompanyName>
<ImageLink>string</ImageLink>
<ImageThumbLink>string</ImageThumbLink>
<Code_Type>string</Code_Type>
<Code_Series>string</Code_Series>
<CPDValue>int</CPDValue>
<DefaultBookingFormName>string</DefaultBookingFormName>
<DefaultBookingFormUrl>string</DefaultBookingFormUrl>
<DefaultWebsiteID>int</DefaultWebsiteID>
<DefaultWebsiteName>string</DefaultWebsiteName>
<DefaultWebsitePageFriendlyName>string</DefaultWebsitePageFriendlyName>
<StartTime>dateTime</StartTime>
<EndTime>dateTime</EndTime>
<Location>string</Location>
<Organisers>string</Organisers>
<Collaborators>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
<CollaboratorResponse>
<Name>string</Name>
<Type>string</Type>
<Order>int</Order>
<EventLink>string</EventLink>
<EventLinkItem>string</EventLinkItem>
</CollaboratorResponse>
</Collaborators>
<Links>
<string>string</string>
<string>string</string>
</Links>
</EventDetailsResponse3>