GET CPS/EventsList?eventStartDate={eventStartDate}&eventEndDate={eventEndDate}&isKeyEvent={isKeyEvent}&eventCount={eventCount}&calendarID={calendarID}&TagID={TagID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
eventStartDate | date |
None. |
|
eventEndDate | date |
None. |
|
isKeyEvent | string |
Default value is N |
|
eventCount | integer |
Default value is 0 |
|
calendarID | string |
Default value is |
|
TagID | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of GetEvents_ResultName | Description | Type | Additional information |
---|---|---|---|
CalendarEventsID | integer |
None. |
|
eventTitle | string |
None. |
|
eventDescription | string |
None. |
|
eventLocation | string |
None. |
|
eventStartDate | date |
None. |
|
eventEndDate | date |
None. |
|
contactName | string |
None. |
|
contactEmail | string |
None. |
|
contactPhone | string |
None. |
|
isKeyEvent | string |
None. |
|
keyEventRanking | integer |
None. |
|
eventRank | integer |
None. |
|
calendarColor | string |
None. |
|
calendarName | string |
None. |
|
calendarID | integer |
None. |
|
calendarForeColor | string |
None. |
|
tagName | string |
None. |
|
tagID | integer |
None. |
|
eventLocationTitle | string |
None. |
|
contactTitle | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "CalendarEventsID": 1, "eventTitle": "sample string 2", "eventDescription": "sample string 3", "eventLocation": "sample string 4", "eventStartDate": "2024-11-02T01:11:56.6125544-05:00", "eventEndDate": "2024-11-02T01:11:56.6125544-05:00", "contactName": "sample string 7", "contactEmail": "sample string 8", "contactPhone": "sample string 9", "isKeyEvent": "sample string 10", "keyEventRanking": 1, "eventRank": 11, "calendarColor": "sample string 12", "calendarName": "sample string 13", "calendarID": 14, "calendarForeColor": "sample string 15", "tagName": "sample string 16", "tagID": 17, "eventLocationTitle": "sample string 18", "contactTitle": "sample string 19" }, { "CalendarEventsID": 1, "eventTitle": "sample string 2", "eventDescription": "sample string 3", "eventLocation": "sample string 4", "eventStartDate": "2024-11-02T01:11:56.6125544-05:00", "eventEndDate": "2024-11-02T01:11:56.6125544-05:00", "contactName": "sample string 7", "contactEmail": "sample string 8", "contactPhone": "sample string 9", "isKeyEvent": "sample string 10", "keyEventRanking": 1, "eventRank": 11, "calendarColor": "sample string 12", "calendarName": "sample string 13", "calendarID": 14, "calendarForeColor": "sample string 15", "tagName": "sample string 16", "tagID": 17, "eventLocationTitle": "sample string 18", "contactTitle": "sample string 19" } ]
application/xml, text/xml
Sample:
<ArrayOfGetEvents_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess"> <GetEvents_Result> <CalendarEventsID>1</CalendarEventsID> <calendarColor>sample string 12</calendarColor> <calendarForeColor>sample string 15</calendarForeColor> <calendarID>14</calendarID> <calendarName>sample string 13</calendarName> <contactEmail>sample string 8</contactEmail> <contactName>sample string 7</contactName> <contactPhone>sample string 9</contactPhone> <contactTitle>sample string 19</contactTitle> <eventDescription>sample string 3</eventDescription> <eventEndDate>2024-11-02T01:11:56.6125544-05:00</eventEndDate> <eventLocation>sample string 4</eventLocation> <eventLocationTitle>sample string 18</eventLocationTitle> <eventRank>11</eventRank> <eventStartDate>2024-11-02T01:11:56.6125544-05:00</eventStartDate> <eventTitle>sample string 2</eventTitle> <isKeyEvent>sample string 10</isKeyEvent> <keyEventRanking>1</keyEventRanking> <tagID>17</tagID> <tagName>sample string 16</tagName> </GetEvents_Result> <GetEvents_Result> <CalendarEventsID>1</CalendarEventsID> <calendarColor>sample string 12</calendarColor> <calendarForeColor>sample string 15</calendarForeColor> <calendarID>14</calendarID> <calendarName>sample string 13</calendarName> <contactEmail>sample string 8</contactEmail> <contactName>sample string 7</contactName> <contactPhone>sample string 9</contactPhone> <contactTitle>sample string 19</contactTitle> <eventDescription>sample string 3</eventDescription> <eventEndDate>2024-11-02T01:11:56.6125544-05:00</eventEndDate> <eventLocation>sample string 4</eventLocation> <eventLocationTitle>sample string 18</eventLocationTitle> <eventRank>11</eventRank> <eventStartDate>2024-11-02T01:11:56.6125544-05:00</eventStartDate> <eventTitle>sample string 2</eventTitle> <isKeyEvent>sample string 10</isKeyEvent> <keyEventRanking>1</keyEventRanking> <tagID>17</tagID> <tagName>sample string 16</tagName> </GetEvents_Result> </ArrayOfGetEvents_Result>