YM REST Services

Members

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

The following routes are available for this service:
POST	/Ams/{ClientID}/Members	Create a new member.
PUT	/Ams/{ClientID}/Members	Update the primary address of an existing member.
GET	/Ams/{ClientID}/Members/{id}	Get the details of a member.

**Members** Parameters:
Name	Parameter	Data Type	Required	Description
typeCode	body	string	No

**Person** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
organization	form	string	No
firstName	form	string	No
lastName	form	string	No
middleName	form	string	No
nameSuffix	form	string	No
emailAddress	form	string	No
primaryAddress	form	Address	No
username	form	string	No
password	form	string	No
isMember	form	bool	No
expirationDate	form	string	No
currentMembershipAllowsMultipleOpenInvoices	form	bool	No
currentMembershipInvoiceIsOpen	form	bool	No
currentMembershipInvoiceAwaitingAutoBill	form	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

**Address** Parameters:
Name	Parameter	Data Type	Required
firstName	form	string	No
lastName	form	string	No
organization	form	string	No
address1	form	string	No
address2	form	string	No
city	form	string	No
location	form	string	No
postalCode	form	string	No
countryCode	form	string	No
countryName	form	string	No
areaCode	form	string	No
phone	form	string	No

**MembersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
memberTypeId	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.

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

{
	typeCode: String,
	id: 0,
	organization: String,
	firstName: String,
	lastName: String,
	middleName: String,
	nameSuffix: String,
	emailAddress: String,
	primaryAddress: 
	{
		firstName: String,
		lastName: String,
		organization: String,
		address1: String,
		address2: String,
		city: String,
		location: String,
		postalCode: String,
		countryCode: String,
		countryName: String,
		areaCode: String,
		phone: String
	},
	username: String,
	password: String,
	isMember: False,
	expirationDate: String,
	currentMembershipAllowsMultipleOpenInvoices: False,
	currentMembershipInvoiceIsOpen: False,
	currentMembershipInvoiceAwaitingAutoBill: False,
	UsingRedis: True,
	AppInitTime: 2024-05-03T00:24:41.1317790-04:00,
	ServerID: WS-4-69-031,
	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-03T01:14:48.3930298-04:00,
	Device: Desktop
}

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

{
	memberTypeId: 0,
	typeCode: String,
	id: 0,
	organization: String,
	firstName: String,
	lastName: String,
	middleName: String,
	nameSuffix: String,
	emailAddress: String,
	primaryAddress: 
	{
		firstName: String,
		lastName: String,
		organization: String,
		address1: String,
		address2: String,
		city: String,
		location: String,
		postalCode: String,
		countryCode: String,
		countryName: String,
		areaCode: String,
		phone: String
	},
	username: String,
	password: String,
	isMember: False,
	expirationDate: String,
	currentMembershipAllowsMultipleOpenInvoices: False,
	currentMembershipInvoiceIsOpen: False,
	currentMembershipInvoiceAwaitingAutoBill: False,
	UsingRedis: True,
	AppInitTime: 2024-05-03T00:24:41.1317790-04:00,
	ServerID: WS-4-69-031,
	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-03T01:14:48.3930298-04:00,
	Device: Desktop
}