YM REST Services

Connections

**Requires Authentication**
Requires any of the roles:	member, oauthmember	Required permission:	CanHaveBuddyList

The following routes are available for this service:
GET	/Ams/{ClientID}/Member/{MemberID}/Connections	Return a list of member connections filtered by status.
POST	/Ams/{ClientID}/Member/{MemberID}/Connections	Send a connection request to another member.
PUT	/Ams/{ClientID}/Member/{MemberID}/Connections	Approve a pending request.
DELETE	/Ams/{ClientID}/Member/{MemberID}/Connections/{ConnectionId}	Remove an existing connection or pending request.
PUT	/Ams/{ClientID}/Member/{MemberID}/Connections/{ConnectionId}	Approve a pending request.

**Connections** Parameters:
Name	Parameter	Data Type	Required	Description
ConnectionFilter	body	ConnectionFilter?	No	Allowable Values Sent Received
ConnectionId	path	int	No
CategoryId	body	int?	No
PageSize	body	int	No
PageNumber	body	int	No
OffSet	body	int	No
Message	body	string	No
NameTerm	body	string	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

**ConnectionsResponse** Parameters:
Name	Parameter	Data Type	Required
ConnectionsList	form	List<Connection>	No
ConnectionStatus	form	ConnectionStatus?	No
Success	form	bool?	No
TotalResultsCount	form	int	No
TargetMemberName	form	string	No

**Connection** Parameters:
Name	Parameter	Data Type	Required
ConnectionStatus	form	ConnectionStatus?	No
ConnectionId	form	int	No
FirstName	form	string	No
LastName	form	string	No
ConnectionName	form	string	No
Organization	form	string	No
HeadShotImage	form	string	No
WorkTitle	form	string	No
MemberType	form	string	No
City	form	string	No
State	form	string	No
Location	form	string	No
Country	form	string	No
Shared	form	bool	No
Email	form	string	No
PhoneLabel	form	string	No
PhoneAreaCode	form	string	No
PhoneNumber	form	string	No
FaxLabel	form	string	No
FaxAreaCode	form	string	No
FaxNumber	form	string	No
CanShow	form	ShowPreferences	No
intCategoryID	form	int	No
IsAmbassador	form	bool	No

**ShowPreferences** Parameters:
Name	Parameter	Data Type	Required
City	form	bool	No
Location	form	bool	No
Country	form	bool	No
Phone	form	bool	No
Fax	form	bool	No
Email	form	bool	No
EmployerName	form	bool	No
EmployerTitle	form	bool	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.

POST /Ams/{ClientID}/Member/{MemberID}/Connections HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ConnectionFilter: 0,
	ConnectionId: 0,
	CategoryId: 0,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	Message: String,
	NameTerm: String,
	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-03T00:37:27.7172769-04:00,
	Device: Desktop
}

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

{
	ConnectionsList: 
	[
		{
			ConnectionStatus: None,
			ConnectionId: 0,
			FirstName: String,
			LastName: String,
			ConnectionName: String,
			Organization: String,
			HeadShotImage: String,
			WorkTitle: String,
			MemberType: String,
			City: String,
			State: String,
			Location: String,
			Country: String,
			Shared: False,
			Email: String,
			PhoneLabel: String,
			PhoneAreaCode: String,
			PhoneNumber: String,
			FaxLabel: String,
			FaxAreaCode: String,
			FaxNumber: String,
			CanShow: 
			{
				City: False,
				Location: False,
				Country: False,
				Phone: False,
				Fax: False,
				Email: False,
				EmployerName: False,
				EmployerTitle: False
			},
			intCategoryID: 0,
			IsAmbassador: False
		}
	],
	ConnectionStatus: None,
	Success: False,
	TotalResultsCount: 0,
	TargetMemberName: String,
	ConnectionFilter: 0,
	ConnectionId: 0,
	CategoryId: 0,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	Message: String,
	NameTerm: String,
	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-03T00:37:27.7329175-04:00,
	Device: Desktop
}

YM REST Services

Connections

Allowable Values

HTTP + JSV