Symphony API V1.0
Click here for a complete list of operations.
GetCalendarEventsByDateRange
This method can be used to retrieve information about a company's events between a range of dates
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/GetCalendarEventsByDateRange" <?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> <GetCalendarEventsByDateRange xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <fromDate>dateTime</fromDate> <toDate>dateTime</toDate> <includeArchived>boolean</includeArchived> </GetCalendarEventsByDateRange> </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> <GetCalendarEventsByDateRangeResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <GetCalendarEventsByDateRangeResult> <SystemOwnerEmail>string</SystemOwnerEmail> <SystemOwnerFullname>string</SystemOwnerFullname> <Events> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> </Events> </GetCalendarEventsByDateRangeResult> </GetCalendarEventsByDateRangeResponse> </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> <GetCalendarEventsByDateRange xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <fromDate>dateTime</fromDate> <toDate>dateTime</toDate> <includeArchived>boolean</includeArchived> </GetCalendarEventsByDateRange> </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> <GetCalendarEventsByDateRangeResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <GetCalendarEventsByDateRangeResult> <SystemOwnerEmail>string</SystemOwnerEmail> <SystemOwnerFullname>string</SystemOwnerFullname> <Events> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> </Events> </GetCalendarEventsByDateRangeResult> </GetCalendarEventsByDateRangeResponse> </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/GetCalendarEventsByDateRange?fromDate=string&toDate=string&includeArchived=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"?> <CalendarEventsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <SystemOwnerEmail>string</SystemOwnerEmail> <SystemOwnerFullname>string</SystemOwnerFullname> <Events> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> </Events> </CalendarEventsResponse>
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/GetCalendarEventsByDateRange HTTP/1.1 Host: developer.sym-online.com Content-Type: application/x-www-form-urlencoded Content-Length: length fromDate=string&toDate=string&includeArchived=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <CalendarEventsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <SystemOwnerEmail>string</SystemOwnerEmail> <SystemOwnerFullname>string</SystemOwnerFullname> <Events> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> <CalendarEventResponse> <EventId>int</EventId> <Title>string</Title> <Description>string</Description> <StartDate>dateTime</StartDate> <Location>string</Location> <Country>string</Country> <Type>string</Type> <EventStatus>string</EventStatus> <NumAttendees>int</NumAttendees> <HelpDeskEmail>string</HelpDeskEmail> </CalendarEventResponse> </Events> </CalendarEventsResponse>