vision.cms.calendarcomponent.event.find Find Events
This function retrieves event records with the use of a date range and a filter.
System Level Parameters
| Name |
Type |
Required |
Description |
| method |
String |
Yes |
API Name |
| timestamp |
String |
Yes |
Timestamp,format is yyyy-MM-dd HH:mm:ss, e.g. 2014-01-25 20:23:30. CMS6 API Server allows the timestamp differ 1 minute. |
| format |
String |
No |
Optional, response format, by default is xml, supports xml,json. |
| app_key |
String |
Yes |
App Key |
| v |
String |
No |
API version, by default 1.0. |
| sign |
String |
Yes |
API Parameters' signature. |
Application Level Parameters
| Name |
Type |
Required |
Description |
| CategoryIDsConstraint |
String |
Yes |
The Category Filter parameter will be used to filter the event by category ids, separate multiple ids by comma. |
| DepartmentIDsConstraint |
String |
Yes |
The Department Filter parameter will be used to filter the event by department ids, separate multiple ids by comma. |
| EndDate |
DateTime |
No |
The End Date parameter sets the upper boundary of the date range filter. |
| Filter |
String |
Yes |
The Filter parameter will be used to search the Title and Sub-Title properties of the event. |
| IncludeLocation |
Boolean |
No |
Include location parameter will include the event location. Type in true or false to include location. |
| PageIndex |
Int32 |
Yes |
The Page Index parameter controls which page of records to retrieve from the request. This parameter works with the Page Size parameter. |
| PageSize |
Int32 |
Yes |
The Page Size parameter controls how many records will be retrieved per request. |
| SortField |
String |
No |
SortField is used to sort the events by a particular field. It currently supports: ID, Title, Status, EventDate. Default is ID. |
| SortOrder |
String |
No |
SortOrder is used to sort the events in a specific order. Supports two values: asc, desc. Default is desc. |
| StartDate |
DateTime |
No |
The Start Date parameter sets the lower boundary of the date range filter. This date should be earlier than the End Date parameter. |
Return Results
| Name |
Type |
Description |
| PagingList |
PagingList<Event> |
This field contains a paging list of the records found in the request. |
Error Code
| Error Code |
Error Description |
Solution |
| 100 |
Missing API Method |
Missing API Method in your post data. |
| 404 |
API URL Wrong |
Check your API URL. |
| 900 |
Authorized Failed |
Contact the website administrator, to check whether the API related feature has been enabled. |
| 901 |
Not Found |
Check your API Method. |
| 902 |
Parameter validation failed |
Check your Application Level parameters. |
| 903 |
App Secret Not Matched |
Check your app secret. |
| 905 |
Signature Wrong |
API timestamp is expired. |
| 906 |
Content Type Name empty |
The content type name empty. |
| 907 |
Content Type Name Not Matched |
The content type name not matched. |