YM REST Services

<back to all web services

EventIDs

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/EventIDsReturn a list of Events for the community optionally filtered by date or event name.
EventIDs Parameters:
NameParameterData TypeRequiredDescription
StartDatequeryDateTime?No
EndDatequeryDateTime?No
NamequerystringNo
Statusquerybool?No
LastModifiedDatequeryDateTime?No
PageSizequeryintNo
PageNumberqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventIDsResponse Parameters:
NameParameterData TypeRequiredDescription
EventIDListformList<EventID>No
EventID Parameters:
NameParameterData TypeRequiredDescription
IDformintNo

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

HTTP + JSON

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":"2024-05-03T06:46:44.9263070-04:00","ServerID":"WS-4-7-585","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":"2024-05-03T09:01:43.7132860-04:00","Device":"Desktop"}