vision.cms.calendarcomponent.event.add Add an Event
This function enable creating an event through API.
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 |
| Address |
String |
Yes |
Address |
| Address2 |
String |
Yes |
Address2 |
| City |
String |
Yes |
Address2 |
| Content |
String |
Yes |
Event content |
| EndDate |
DateTime |
Yes |
The End Date parameter sets the upper boundary of the date range filter. |
| Key |
String |
Yes |
The Key identifies content which created. Format: {app}_{guid}. Example: Peak_b6bd3b48-0361-42ba-aabd-b91dcff6523e |
| StartDate |
DateTime |
Yes |
The Start Date parameter sets the lower boundary of the date range filter. This date should be earlier than the End Date parameter. |
| State |
String |
Yes |
Event State. Can be used as abbreviation or fullname. Ex: MN or Minnesota |
| Title |
String |
Yes |
Event Title |
| Zip |
String |
Yes |
ZipCode of Event |
Return Results
| Name |
Type |
Description |
| EventID |
Int32 |
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. |