YM REST Services

FindMembers

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Required permission:	CanAdminMembers

The following routes are available for this service:
GET	/Ams/{ClientID}/FindMembers	Lookup People - with cache.	Any one or more part of a person's name can be sent in as a term.

**FindMembers** Parameters:
Name	Parameter	Data Type	Required
term	query	string	No
limit	query	int	No
IsAmbassadorSearch	query	bool	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

**FindMembersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
membersFound	form	List<MemberFound>	No

**MemberFound** Parameters:
Name	Parameter	Data Type	Required	Description
id	form	int	No
label	form	string	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}/FindMembers HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	membersFound: 
	[
		{
			id: 0,
			label: String
		}
	],
	term: String,
	limit: 0,
	IsAmbassadorSearch: False,
	UsingRedis: True,
	AppInitTime: 2024-05-03T04:24:57.3067007-04:00,
	ServerID: WS-6-183-431,
	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-03T05:28:11.5187389-04:00,
	Device: Desktop
}