Symphony API V1.0 Web Service

Symphony API V1.0

Click here for a complete list of operations.

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

Test

The test form is only available for requests from the local machine.

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

<?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>
    <GetExtEventsDetails4 xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <clientCompanyId>int</clientCompanyId>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <eventType>string</eventType>
      <eventTitle>string</eventTitle>
      <series>string</series>
      <subClientCompany>string</subClientCompany>
      <profileSearchArray>
        <string>string</string>
        <string>string</string>
      </profileSearchArray>
      <pageNumber>int</pageNumber>
      <resultCount>int</resultCount>
    </GetExtEventsDetails4>
  </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>
    <GetExtEventsDetails4Response xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetExtEventsDetails4Result>
        <TotalEventCount>int</TotalEventCount>
        <Events>
          <EventExtendedDetailsResponse3Details>
            <EventId>int</EventId>
            <Title>string</Title>
            <StartDate>dateTime</StartDate>
            <StartTime>dateTime</StartTime>
            <EndDate>dateTime</EndDate>
            <EndTime>dateTime</EndTime>
            <SignupStartDate>dateTime</SignupStartDate>
            <SignupEndDate>dateTime</SignupEndDate>
            <Description>string</Description>
            <MediumDescription>string</MediumDescription>
            <Status>string</Status>
            <Location>string</Location>
            <Organisers>string</Organisers>
            <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>
            <ThirdPartyEvent>boolean</ThirdPartyEvent>
            <ExternalURL>string</ExternalURL>
            <Code_Room>string</Code_Room>
            <ClientCompanyName>string</ClientCompanyName>
            <HelplineName>string</HelplineName>
            <HelplineTelephone>string</HelplineTelephone>
            <HelplineEmail>string</HelplineEmail>
            <ImageLink>string</ImageLink>
            <ImageThumbLink>string</ImageThumbLink>
            <SubClientCompanyName>string</SubClientCompanyName>
          </EventExtendedDetailsResponse3Details>
          <EventExtendedDetailsResponse3Details>
            <EventId>int</EventId>
            <Title>string</Title>
            <StartDate>dateTime</StartDate>
            <StartTime>dateTime</StartTime>
            <EndDate>dateTime</EndDate>
            <EndTime>dateTime</EndTime>
            <SignupStartDate>dateTime</SignupStartDate>
            <SignupEndDate>dateTime</SignupEndDate>
            <Description>string</Description>
            <MediumDescription>string</MediumDescription>
            <Status>string</Status>
            <Location>string</Location>
            <Organisers>string</Organisers>
            <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>
            <ThirdPartyEvent>boolean</ThirdPartyEvent>
            <ExternalURL>string</ExternalURL>
            <Code_Room>string</Code_Room>
            <ClientCompanyName>string</ClientCompanyName>
            <HelplineName>string</HelplineName>
            <HelplineTelephone>string</HelplineTelephone>
            <HelplineEmail>string</HelplineEmail>
            <ImageLink>string</ImageLink>
            <ImageThumbLink>string</ImageThumbLink>
            <SubClientCompanyName>string</SubClientCompanyName>
          </EventExtendedDetailsResponse3Details>
        </Events>
      </GetExtEventsDetails4Result>
    </GetExtEventsDetails4Response>
  </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>
    <GetExtEventsDetails4 xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <clientCompanyId>int</clientCompanyId>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <eventType>string</eventType>
      <eventTitle>string</eventTitle>
      <series>string</series>
      <subClientCompany>string</subClientCompany>
      <profileSearchArray>
        <string>string</string>
        <string>string</string>
      </profileSearchArray>
      <pageNumber>int</pageNumber>
      <resultCount>int</resultCount>
    </GetExtEventsDetails4>
  </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>
    <GetExtEventsDetails4Response xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetExtEventsDetails4Result>
        <TotalEventCount>int</TotalEventCount>
        <Events>
          <EventExtendedDetailsResponse3Details>
            <EventId>int</EventId>
            <Title>string</Title>
            <StartDate>dateTime</StartDate>
            <StartTime>dateTime</StartTime>
            <EndDate>dateTime</EndDate>
            <EndTime>dateTime</EndTime>
            <SignupStartDate>dateTime</SignupStartDate>
            <SignupEndDate>dateTime</SignupEndDate>
            <Description>string</Description>
            <MediumDescription>string</MediumDescription>
            <Status>string</Status>
            <Location>string</Location>
            <Organisers>string</Organisers>
            <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>
            <ThirdPartyEvent>boolean</ThirdPartyEvent>
            <ExternalURL>string</ExternalURL>
            <Code_Room>string</Code_Room>
            <ClientCompanyName>string</ClientCompanyName>
            <HelplineName>string</HelplineName>
            <HelplineTelephone>string</HelplineTelephone>
            <HelplineEmail>string</HelplineEmail>
            <ImageLink>string</ImageLink>
            <ImageThumbLink>string</ImageThumbLink>
            <SubClientCompanyName>string</SubClientCompanyName>
          </EventExtendedDetailsResponse3Details>
          <EventExtendedDetailsResponse3Details>
            <EventId>int</EventId>
            <Title>string</Title>
            <StartDate>dateTime</StartDate>
            <StartTime>dateTime</StartTime>
            <EndDate>dateTime</EndDate>
            <EndTime>dateTime</EndTime>
            <SignupStartDate>dateTime</SignupStartDate>
            <SignupEndDate>dateTime</SignupEndDate>
            <Description>string</Description>
            <MediumDescription>string</MediumDescription>
            <Status>string</Status>
            <Location>string</Location>
            <Organisers>string</Organisers>
            <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>
            <ThirdPartyEvent>boolean</ThirdPartyEvent>
            <ExternalURL>string</ExternalURL>
            <Code_Room>string</Code_Room>
            <ClientCompanyName>string</ClientCompanyName>
            <HelplineName>string</HelplineName>
            <HelplineTelephone>string</HelplineTelephone>
            <HelplineEmail>string</HelplineEmail>
            <ImageLink>string</ImageLink>
            <ImageThumbLink>string</ImageThumbLink>
            <SubClientCompanyName>string</SubClientCompanyName>
          </EventExtendedDetailsResponse3Details>
        </Events>
      </GetExtEventsDetails4Result>
    </GetExtEventsDetails4Response>
  </soap12:Body>
</soap12:Envelope>