Symphony API V1.0


Click here for a complete list of operations.

GetEventsForUser

This method can be used to retrieve basic details of all the events available to the specified user

Test

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

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

<?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>
    <GetEventsForUser xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <userId>int</userId>
      <includePastEvents>boolean</includePastEvents>
    </GetEventsForUser>
  </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>
    <GetEventsForUserResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetEventsForUserResult>
        <EventBasicResponse>
          <EventId>int</EventId>
          <Code>string</Code>
          <Title>string</Title>
        </EventBasicResponse>
        <EventBasicResponse>
          <EventId>int</EventId>
          <Code>string</Code>
          <Title>string</Title>
        </EventBasicResponse>
      </GetEventsForUserResult>
    </GetEventsForUserResponse>
  </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>
    <GetEventsForUser xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <userId>int</userId>
      <includePastEvents>boolean</includePastEvents>
    </GetEventsForUser>
  </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>
    <GetEventsForUserResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetEventsForUserResult>
        <EventBasicResponse>
          <EventId>int</EventId>
          <Code>string</Code>
          <Title>string</Title>
        </EventBasicResponse>
        <EventBasicResponse>
          <EventId>int</EventId>
          <Code>string</Code>
          <Title>string</Title>
        </EventBasicResponse>
      </GetEventsForUserResult>
    </GetEventsForUserResponse>
  </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/GetEventsForUser?userId=string&includePastEvents=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"?>
<ArrayOfEventBasicResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <EventBasicResponse>
    <EventId>int</EventId>
    <Code>string</Code>
    <Title>string</Title>
  </EventBasicResponse>
  <EventBasicResponse>
    <EventId>int</EventId>
    <Code>string</Code>
    <Title>string</Title>
  </EventBasicResponse>
</ArrayOfEventBasicResponse>

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

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfEventBasicResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <EventBasicResponse>
    <EventId>int</EventId>
    <Code>string</Code>
    <Title>string</Title>
  </EventBasicResponse>
  <EventBasicResponse>
    <EventId>int</EventId>
    <Code>string</Code>
    <Title>string</Title>
  </EventBasicResponse>
</ArrayOfEventBasicResponse>