YM REST Services

DirectorySearch

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Member/{MemberID}/DirectorySearch	Return a list of members based on term.

**DirectorySearch** Parameters:
Name	Parameter	Data Type	Required
Term	query	string	No
PageSize	query	int	No
StartIndex	query	int	No
IncludeNonMembers	query	bool	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	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

**DirectorySearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResultCount	form	int	No
DirectorySearchProfileList	form	List<DirectorySearchProfile>	No

**DirectorySearchProfile** Parameters:
Name	Parameter	Data Type	Required
CanHaveConnections	form	bool	No
CanUseMessaging	form	bool	No
MemberID	form	int	No
PrimaryGroupName	form	string	No
IsMember	form	bool	No
IsNonMember	form	bool	No
Name	form	string	No
City	form	string	No
Location	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
Phone	form	string	No
HeadshotImagePath	form	string	No
NonMemberLost	form	bool	No
NonMemberDeceased	form	bool	No
NonMemberComments	form	string	No
JobTitle	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}/Member/{MemberID}/DirectorySearch HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	ResultCount: 0,
	DirectorySearchProfileList: 
	[
		{
			CanHaveConnections: False,
			CanUseMessaging: False,
			MemberID: 0,
			PrimaryGroupName: String,
			IsMember: False,
			IsNonMember: False,
			Name: String,
			City: String,
			Location: String,
			AddressLine1: String,
			AddressLine2: String,
			Phone: String,
			HeadshotImagePath: String,
			NonMemberLost: False,
			NonMemberDeceased: False,
			NonMemberComments: String,
			JobTitle: String
		}
	],
	Term: String,
	PageSize: 0,
	StartIndex: 0,
	IncludeNonMembers: False,
	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-03T10:42:25.7905643-04:00,
	Device: Desktop
}