Requires any of the roles: | admin, oauthadmin |
GET | /Ams/{ClientID}/EventIDs | Return a list of Events for the community optionally filtered by date or event name. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartDate | query | DateTime? | No | |
EndDate | query | DateTime? | No | |
Name | query | string | No | |
Status | query | bool? | No | |
LastModifiedDate | query | DateTime? | No | |
PageSize | query | int | No | |
PageNumber | query | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UsingRedis | form | bool | No | |
AppInitTime | form | DateTime | No | |
ServerID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EventIDList | form | List<EventID> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/EventIDs HTTP/1.1 Host: ws.yourmembership.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"EventIDList":[{"ID":0}],"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Name":"String","Status":false,"LastModifiedDate":"0001-01-01T00:00:00.0000000","PageSize":0,"PageNumber":0,"UsingRedis":true,"AppInitTime":"2025-01-15T07:15:52.7259632-05:00","ServerID":"WS-4-190-907","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T08:57:32.5777668-05:00","Device":"Desktop"}