YM REST Services

<back to all web services

EventSearch

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/EventSearchReturn a list of Community Events based on the supplied search term.
EventSearch Parameters:
NameParameterData TypeRequiredDescription
SearchTextquerystringNo
PageSizequeryintNo
PageNumberqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventSearchResponse Parameters:
NameParameterData TypeRequiredDescription
EventsformList<EventDetail>No
TotalResultsCountformintNo
EventDetail Parameters:
NameParameterData TypeRequiredDescription
EventNameformstringNo
EventIDformintNo
EventDateformstringNo

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}/Member/{MemberID}/EventSearch HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Events":[{"EventName":"String","EventID":0,"EventDate":"String"}],"TotalResultsCount":0,"SearchText":"String","PageSize":0,"PageNumber":0,"MemberID":0,"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-03T06:48:48.7469561-04:00","Device":"Desktop"}