Symphony API V1.0


Click here for a complete list of operations.

EventProfileSearch

This method can be used to run a dynamic query and return a list of events based on the search parameters

Test

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

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

<?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>
    <EventProfileSearch xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <searchQuery>string</searchQuery>
    </EventProfileSearch>
  </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>
    <EventProfileSearchResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <EventProfileSearchResult>
        <Events>
          <EventModel>
            <Event xsi:nil="true" />
            <Websites xsi:nil="true" />
          </EventModel>
          <EventModel>
            <Event xsi:nil="true" />
            <Websites xsi:nil="true" />
          </EventModel>
        </Events>
      </EventProfileSearchResult>
    </EventProfileSearchResponse>
  </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>
    <EventProfileSearch xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <searchQuery>string</searchQuery>
    </EventProfileSearch>
  </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>
    <EventProfileSearchResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <EventProfileSearchResult>
        <Events>
          <EventModel>
            <Event xsi:nil="true" />
            <Websites xsi:nil="true" />
          </EventModel>
          <EventModel>
            <Event xsi:nil="true" />
            <Websites xsi:nil="true" />
          </EventModel>
        </Events>
      </EventProfileSearchResult>
    </EventProfileSearchResponse>
  </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/EventProfileSearch?searchQuery=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"?>
<EventProfileSearchResponseModel xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <Events>
    <EventModel>
      <Event>
        <EventId>int</EventId>
        <Title>string</Title>
        <Description>string</Description>
        <Code>string</Code>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <UseGlobalContactList>boolean</UseGlobalContactList>
        <HasCapacityLimits>boolean</HasCapacityLimits>
        <EventCapacity>int</EventCapacity>
        <SignupStartDate>dateTime</SignupStartDate>
        <SignupEndDate>dateTime</SignupEndDate>
        <BookingReferencePrefix>string</BookingReferencePrefix>
        <InvoiceReferencePrefix>string</InvoiceReferencePrefix>
        <DefaultTaxRate>decimal</DefaultTaxRate>
        <HelplineName>string</HelplineName>
        <HelplineTelephoneNumber>string</HelplineTelephoneNumber>
        <HelplineEmail>string</HelplineEmail>
        <IsArchived>boolean</IsArchived>
        <HasSetupBasicDetails>boolean</HasSetupBasicDetails>
        <HasSetupEventCapacity>boolean</HasSetupEventCapacity>
        <ExternalSystemId>string</ExternalSystemId>
        <EventLeader>string</EventLeader>
        <Location>string</Location>
        <Country>string</Country>
        <Type>string</Type>
        <EventStatus>string</EventStatus>
        <StatusCreatedDate>dateTime</StatusCreatedDate>
        <StatusCreatedSource>string</StatusCreatedSource>
        <StatusLastUpdatedDate>dateTime</StatusLastUpdatedDate>
        <StatusLastUpdatedSource>string</StatusLastUpdatedSource>
        <StatusIsDeleted>boolean</StatusIsDeleted>
        <StatusDeletedDate>dateTime</StatusDeletedDate>
        <StatusDeletedSource>string</StatusDeletedSource>
        <StatusIsActive>boolean</StatusIsActive>
        <StatusInactiveReason>string</StatusInactiveReason>
        <ProjectCode>string</ProjectCode>
        <CostCentre>string</CostCentre>
        <CPDValue>int</CPDValue>
        <Series>string</Series>
        <ExcludeFromAPI>boolean</ExcludeFromAPI>
        <DelegateInstruction>string</DelegateInstruction>
        <Desc_Long>string</Desc_Long>
        <Desc_Med>string</Desc_Med>
        <Anal01>string</Anal01>
        <Anal02>string</Anal02>
        <ThirdParty>boolean</ThirdParty>
        <ExternalURL>string</ExternalURL>
        <IsEventFree>boolean</IsEventFree>
        <SubClientCo>string</SubClientCo>
        <Notes>string</Notes>
        <Room>string</Room>
        <IsTemplateEvent>boolean</IsTemplateEvent>
        <ExtFinanceDetails>boolean</ExtFinanceDetails>
        <ImportGuid>string</ImportGuid>
        <EnableWaitingList>boolean</EnableWaitingList>
        <Links>string</Links>
        <Terms>string</Terms>
        <VirtualEvent>boolean</VirtualEvent>
        <ExternalURLPwd>string</ExternalURLPwd>
        <ClientCompanyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CurrencyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event2Reference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RoadshowReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserCreatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserDeletedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserLastUpdatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Event>
      <Websites>
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Websites>
    </EventModel>
    <EventModel>
      <Event>
        <EventId>int</EventId>
        <Title>string</Title>
        <Description>string</Description>
        <Code>string</Code>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <UseGlobalContactList>boolean</UseGlobalContactList>
        <HasCapacityLimits>boolean</HasCapacityLimits>
        <EventCapacity>int</EventCapacity>
        <SignupStartDate>dateTime</SignupStartDate>
        <SignupEndDate>dateTime</SignupEndDate>
        <BookingReferencePrefix>string</BookingReferencePrefix>
        <InvoiceReferencePrefix>string</InvoiceReferencePrefix>
        <DefaultTaxRate>decimal</DefaultTaxRate>
        <HelplineName>string</HelplineName>
        <HelplineTelephoneNumber>string</HelplineTelephoneNumber>
        <HelplineEmail>string</HelplineEmail>
        <IsArchived>boolean</IsArchived>
        <HasSetupBasicDetails>boolean</HasSetupBasicDetails>
        <HasSetupEventCapacity>boolean</HasSetupEventCapacity>
        <ExternalSystemId>string</ExternalSystemId>
        <EventLeader>string</EventLeader>
        <Location>string</Location>
        <Country>string</Country>
        <Type>string</Type>
        <EventStatus>string</EventStatus>
        <StatusCreatedDate>dateTime</StatusCreatedDate>
        <StatusCreatedSource>string</StatusCreatedSource>
        <StatusLastUpdatedDate>dateTime</StatusLastUpdatedDate>
        <StatusLastUpdatedSource>string</StatusLastUpdatedSource>
        <StatusIsDeleted>boolean</StatusIsDeleted>
        <StatusDeletedDate>dateTime</StatusDeletedDate>
        <StatusDeletedSource>string</StatusDeletedSource>
        <StatusIsActive>boolean</StatusIsActive>
        <StatusInactiveReason>string</StatusInactiveReason>
        <ProjectCode>string</ProjectCode>
        <CostCentre>string</CostCentre>
        <CPDValue>int</CPDValue>
        <Series>string</Series>
        <ExcludeFromAPI>boolean</ExcludeFromAPI>
        <DelegateInstruction>string</DelegateInstruction>
        <Desc_Long>string</Desc_Long>
        <Desc_Med>string</Desc_Med>
        <Anal01>string</Anal01>
        <Anal02>string</Anal02>
        <ThirdParty>boolean</ThirdParty>
        <ExternalURL>string</ExternalURL>
        <IsEventFree>boolean</IsEventFree>
        <SubClientCo>string</SubClientCo>
        <Notes>string</Notes>
        <Room>string</Room>
        <IsTemplateEvent>boolean</IsTemplateEvent>
        <ExtFinanceDetails>boolean</ExtFinanceDetails>
        <ImportGuid>string</ImportGuid>
        <EnableWaitingList>boolean</EnableWaitingList>
        <Links>string</Links>
        <Terms>string</Terms>
        <VirtualEvent>boolean</VirtualEvent>
        <ExternalURLPwd>string</ExternalURLPwd>
        <ClientCompanyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CurrencyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event2Reference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RoadshowReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserCreatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserDeletedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserLastUpdatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Event>
      <Websites>
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Websites>
    </EventModel>
  </Events>
</EventProfileSearchResponseModel>

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

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

<?xml version="1.0" encoding="utf-8"?>
<EventProfileSearchResponseModel xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <Events>
    <EventModel>
      <Event>
        <EventId>int</EventId>
        <Title>string</Title>
        <Description>string</Description>
        <Code>string</Code>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <UseGlobalContactList>boolean</UseGlobalContactList>
        <HasCapacityLimits>boolean</HasCapacityLimits>
        <EventCapacity>int</EventCapacity>
        <SignupStartDate>dateTime</SignupStartDate>
        <SignupEndDate>dateTime</SignupEndDate>
        <BookingReferencePrefix>string</BookingReferencePrefix>
        <InvoiceReferencePrefix>string</InvoiceReferencePrefix>
        <DefaultTaxRate>decimal</DefaultTaxRate>
        <HelplineName>string</HelplineName>
        <HelplineTelephoneNumber>string</HelplineTelephoneNumber>
        <HelplineEmail>string</HelplineEmail>
        <IsArchived>boolean</IsArchived>
        <HasSetupBasicDetails>boolean</HasSetupBasicDetails>
        <HasSetupEventCapacity>boolean</HasSetupEventCapacity>
        <ExternalSystemId>string</ExternalSystemId>
        <EventLeader>string</EventLeader>
        <Location>string</Location>
        <Country>string</Country>
        <Type>string</Type>
        <EventStatus>string</EventStatus>
        <StatusCreatedDate>dateTime</StatusCreatedDate>
        <StatusCreatedSource>string</StatusCreatedSource>
        <StatusLastUpdatedDate>dateTime</StatusLastUpdatedDate>
        <StatusLastUpdatedSource>string</StatusLastUpdatedSource>
        <StatusIsDeleted>boolean</StatusIsDeleted>
        <StatusDeletedDate>dateTime</StatusDeletedDate>
        <StatusDeletedSource>string</StatusDeletedSource>
        <StatusIsActive>boolean</StatusIsActive>
        <StatusInactiveReason>string</StatusInactiveReason>
        <ProjectCode>string</ProjectCode>
        <CostCentre>string</CostCentre>
        <CPDValue>int</CPDValue>
        <Series>string</Series>
        <ExcludeFromAPI>boolean</ExcludeFromAPI>
        <DelegateInstruction>string</DelegateInstruction>
        <Desc_Long>string</Desc_Long>
        <Desc_Med>string</Desc_Med>
        <Anal01>string</Anal01>
        <Anal02>string</Anal02>
        <ThirdParty>boolean</ThirdParty>
        <ExternalURL>string</ExternalURL>
        <IsEventFree>boolean</IsEventFree>
        <SubClientCo>string</SubClientCo>
        <Notes>string</Notes>
        <Room>string</Room>
        <IsTemplateEvent>boolean</IsTemplateEvent>
        <ExtFinanceDetails>boolean</ExtFinanceDetails>
        <ImportGuid>string</ImportGuid>
        <EnableWaitingList>boolean</EnableWaitingList>
        <Links>string</Links>
        <Terms>string</Terms>
        <VirtualEvent>boolean</VirtualEvent>
        <ExternalURLPwd>string</ExternalURLPwd>
        <ClientCompanyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CurrencyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event2Reference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RoadshowReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserCreatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserDeletedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserLastUpdatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Event>
      <Websites>
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Websites>
    </EventModel>
    <EventModel>
      <Event>
        <EventId>int</EventId>
        <Title>string</Title>
        <Description>string</Description>
        <Code>string</Code>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <UseGlobalContactList>boolean</UseGlobalContactList>
        <HasCapacityLimits>boolean</HasCapacityLimits>
        <EventCapacity>int</EventCapacity>
        <SignupStartDate>dateTime</SignupStartDate>
        <SignupEndDate>dateTime</SignupEndDate>
        <BookingReferencePrefix>string</BookingReferencePrefix>
        <InvoiceReferencePrefix>string</InvoiceReferencePrefix>
        <DefaultTaxRate>decimal</DefaultTaxRate>
        <HelplineName>string</HelplineName>
        <HelplineTelephoneNumber>string</HelplineTelephoneNumber>
        <HelplineEmail>string</HelplineEmail>
        <IsArchived>boolean</IsArchived>
        <HasSetupBasicDetails>boolean</HasSetupBasicDetails>
        <HasSetupEventCapacity>boolean</HasSetupEventCapacity>
        <ExternalSystemId>string</ExternalSystemId>
        <EventLeader>string</EventLeader>
        <Location>string</Location>
        <Country>string</Country>
        <Type>string</Type>
        <EventStatus>string</EventStatus>
        <StatusCreatedDate>dateTime</StatusCreatedDate>
        <StatusCreatedSource>string</StatusCreatedSource>
        <StatusLastUpdatedDate>dateTime</StatusLastUpdatedDate>
        <StatusLastUpdatedSource>string</StatusLastUpdatedSource>
        <StatusIsDeleted>boolean</StatusIsDeleted>
        <StatusDeletedDate>dateTime</StatusDeletedDate>
        <StatusDeletedSource>string</StatusDeletedSource>
        <StatusIsActive>boolean</StatusIsActive>
        <StatusInactiveReason>string</StatusInactiveReason>
        <ProjectCode>string</ProjectCode>
        <CostCentre>string</CostCentre>
        <CPDValue>int</CPDValue>
        <Series>string</Series>
        <ExcludeFromAPI>boolean</ExcludeFromAPI>
        <DelegateInstruction>string</DelegateInstruction>
        <Desc_Long>string</Desc_Long>
        <Desc_Med>string</Desc_Med>
        <Anal01>string</Anal01>
        <Anal02>string</Anal02>
        <ThirdParty>boolean</ThirdParty>
        <ExternalURL>string</ExternalURL>
        <IsEventFree>boolean</IsEventFree>
        <SubClientCo>string</SubClientCo>
        <Notes>string</Notes>
        <Room>string</Room>
        <IsTemplateEvent>boolean</IsTemplateEvent>
        <ExtFinanceDetails>boolean</ExtFinanceDetails>
        <ImportGuid>string</ImportGuid>
        <EnableWaitingList>boolean</EnableWaitingList>
        <Links>string</Links>
        <Terms>string</Terms>
        <VirtualEvent>boolean</VirtualEvent>
        <ExternalURLPwd>string</ExternalURLPwd>
        <ClientCompanyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CurrencyReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event2Reference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RoadshowReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserCreatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserDeletedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ClientUserLastUpdatedReference d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Event>
      <Websites>
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <WebsiteModel d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Websites>
    </EventModel>
  </Events>
</EventProfileSearchResponseModel>