YM REST Services

EventIDs

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/EventIDs	Return a list of Events for the community optionally filtered by date or event name.

**EventIDs** Parameters:
Name	Parameter	Data Type	Required
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

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**EventIDsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
EventIDList	form	List<EventID>	No

**EventID** Parameters:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EventIDList: 
	[
		{
			ID: 0
		}
	],
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	Name: String,
	Status: False,
	LastModifiedDate: 0001-01-01,
	PageSize: 0,
	PageNumber: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T01:46:05.4743219-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-03T04:15:48.4054446-04:00,
	Device: Desktop
}