YM REST Services

MemberList

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

The following routes are available for this service:
GET	/Ams/{ClientID}/MemberList	Returns a list of Members, based on GroupCode	Required parameters are PageSize, PageNumber. FieldSelection is a string that accepts a combination of member's response fields seperated by comma.

**MemberList** Parameters:
Name	Parameter	Data Type	Required
GroupCode	query	string	No
PageSize	query	int	No
PageNumber	query	int	No
FieldSelection	query	string	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

**MemberListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Members	form	List<MemberResponse>	No
TotalMemberFound	form	int	No

**MemberResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ProfileID	form	int	No
IsMember	form	bool	No
ImportID	form	string	No
Approved	form	bool?	No
Suspended	form	bool	No
MasterID	form	string	No
ApprovalDate	form	DateTime?	No
QueuedForDelete	form	bool	No
QueuedForDeleteDate	form	DateTime	No
MembershipEffectiveExpiresDate	form	DateTime	No
EmailBounced	form	bool?	No
HasConsented	form	bool	No
DateConsented	form	DateTime	No
ConsentIPAddress	form	string	No
HasRevokedConsent	form	bool	No
DateConsentRevoked	form	DateTime	No
MasterProfileID	form	string	No	This key replaces the “MasterID” key.
UserName	form	string	No
MembershipExpires	form	bool	No
MembershipExpiresDate	form	DateTime	No
SubordinateSeats	form	int	No
ConstituentID	form	string	No
MemberTypeCode	form	string	No
Registered	form	DateTime	No
Membership	form	string	No
LastRenewalDate	form	DateTime	No
LastRenewalReminderSent	form	DateTime	No
PrimaryGroupCode	form	string	No
LastUpdated	form	DateTime	No
Gender	form	string	No
Prefix	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
Suffix	form	string	No
NickName	form	string	No
MaidenName	form	string	No
SpouseName	form	string	No
MaritalStatus	form	string	No
AnniversaryDate	form	DateTime	No
BirthdayDate	form	DateTime	No
HomeUrl	form	string	No
HomeAddressLine1	form	string	No
HomeAddressLine2	form	string	No
HomeAddressCity	form	string	No
HomeAddressLocation	form	string	No
HomeAddressPostalCode	form	string	No
HomeAddressCountry	form	string	No
HomePhoneCountryCode	form	string	No
HomePhoneAreaCode	form	string	No
HomePhoneNumber	form	string	No
HomeFaxNumber	form	string	No
HomeFaxCountryCode	form	string	No
HomeFaxAreaCode	form	string	No
Email	form	string	No
EmailAlt	form	string	No
HeadshotImageURI	form	string	No
EmployerName	form	string	No
SelfEmployed	form	bool	No
WorkTitle	form	string	No
WorkType	form	string	No
WorkUrl	form	string	No
WorkAddressLine1	form	string	No
WorkAddressLine2	form	string	No
WorkAddressCity	form	string	No
WorkAddressLocation	form	string	No
WorkAddressPostalCode	form	string	No
WorkAddressCountry	form	string	No
WorkPhoneCountryCode	form	string	No
WorkPhoneNumber	form	string	No
WorkPhoneAreaCode	form	string	No
WorkFaxNumber	form	string	No
WorkFaxAreaCode	form	string	No
PersonalComments	form	string	No
AdditionalEdu	form	string	No
SocialOrgs	form	string	No
PreferredAddressLatitude	form	decimal	No
PreferredAddressLongitude	form	decimal	No
MemberCustomFieldResponses	form	CustomFieldResponses	No

**CustomFieldResponse** Parameters:
Name	Parameter	Data Type	Required
FieldCode	form	string	No
Fields	form	CustomFields	No
Visibility	form	string	No
VisibilityInt	form	int	No
Values	form	List<CustomFieldResponseValue>	No
ValuesProxy	form	ArrayList	No
MetaValue	form	CustomFieldResponseValue	No
ClientID	form	int	No

**CustomField** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
FieldType	form	CustomFieldType	No
GroupCode	form	string	No
GroupCodeFriendly	form	string	No
Required	form	bool	No
Visible	form	int	No
MemberCanOverride	form	bool	No
Editable	form	int	No
Searchable	form	bool	No
Ordinal	form	int	No
MaxLength	form	int	No
IsMultiSelect	form	bool	No
IsFIB	form	bool	No
IsFileUpload	form	bool	No
Label	form	string	No
Code	form	string	No
ExportLabel	form	string	No
SearchLabel	form	string	No
SearchInfo	form	string	No
Description	form	string	No
ValidationExpression	form	string	No
MemberTypes	form	List<CustomFieldMemberType>	No
DonationFunds	form	List<CustomFieldDonationFund>	No
MemberTypesProxy	form	ArrayList	No
Values	form	List<CustomFieldValue>	No
ValuesProxy	form	ArrayList	No
HelpTopic	form	CustomHelp	No
FieldDataType	form	FieldTypes	No

**CustomFieldMemberType** Parameters:
Name	Parameter	Data Type	Required	Description
MemberTypeID	form	string	No

**CustomFieldDonationFund** Parameters:
Name	Parameter	Data Type	Required	Description
DonationFundID	form	string	No

**CustomFieldValue** Parameters:
Name	Parameter	Data Type	Required
Ordinal	form	int	No
Text	form	string	No
Value	form	string	No

**CustomHelp** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
ClientID	form	int	No
Label	form	string	No
Content	form	string	No
Width	form	int	No
Height	form	int	No

**CustomFieldResponseValue** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	No
Text	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}/MemberList HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	Members: 
	[
		{
			ProfileID: 0,
			IsMember: False,
			ImportID: String,
			Approved: False,
			Suspended: False,
			MasterID: String,
			ApprovalDate: 0001-01-01,
			QueuedForDelete: False,
			QueuedForDeleteDate: 0001-01-01,
			MembershipEffectiveExpiresDate: 0001-01-01,
			EmailBounced: False,
			HasConsented: False,
			DateConsented: 0001-01-01,
			ConsentIPAddress: String,
			HasRevokedConsent: False,
			DateConsentRevoked: 0001-01-01,
			MasterProfileID: String,
			UserName: String,
			MembershipExpires: False,
			MembershipExpiresDate: 0001-01-01,
			SubordinateSeats: 0,
			ConstituentID: String,
			MemberTypeCode: String,
			Registered: 0001-01-01,
			Membership: String,
			LastRenewalDate: 0001-01-01,
			LastRenewalReminderSent: 0001-01-01,
			PrimaryGroupCode: String,
			LastUpdated: 0001-01-01,
			Gender: String,
			Prefix: String,
			FirstName: String,
			MiddleName: String,
			LastName: String,
			Suffix: String,
			NickName: String,
			MaidenName: String,
			SpouseName: String,
			MaritalStatus: String,
			AnniversaryDate: 0001-01-01,
			BirthdayDate: 0001-01-01,
			HomeUrl: String,
			HomeAddressLine1: String,
			HomeAddressLine2: String,
			HomeAddressCity: String,
			HomeAddressLocation: String,
			HomeAddressPostalCode: String,
			HomeAddressCountry: String,
			HomePhoneCountryCode: String,
			HomePhoneAreaCode: String,
			HomePhoneNumber: String,
			HomeFaxNumber: String,
			HomeFaxCountryCode: String,
			HomeFaxAreaCode: String,
			Email: String,
			EmailAlt: String,
			HeadshotImageURI: String,
			EmployerName: String,
			SelfEmployed: False,
			WorkTitle: String,
			WorkType: String,
			WorkUrl: String,
			WorkAddressLine1: String,
			WorkAddressLine2: String,
			WorkAddressCity: String,
			WorkAddressLocation: String,
			WorkAddressPostalCode: String,
			WorkAddressCountry: String,
			WorkPhoneCountryCode: String,
			WorkPhoneNumber: String,
			WorkPhoneAreaCode: String,
			WorkFaxNumber: String,
			WorkFaxAreaCode: String,
			PersonalComments: String,
			AdditionalEdu: String,
			SocialOrgs: String,
			PreferredAddressLatitude: 0,
			PreferredAddressLongitude: 0,
			MemberCustomFieldResponses: 
			[
				{
					FieldCode: String,
					Fields: 
					[
						{
							ClientID: 0,
							FieldType: Textbox,
							GroupCode: String,
							GroupCodeFriendly: String,
							Required: False,
							Visible: 0,
							MemberCanOverride: False,
							Editable: 0,
							Searchable: False,
							Ordinal: 0,
							MaxLength: 0,
							IsMultiSelect: False,
							IsFIB: True,
							IsFileUpload: False,
							Label: String,
							Code: String,
							ExportLabel: String,
							SearchLabel: String,
							SearchInfo: String,
							Description: String,
							ValidationExpression: String,
							MemberTypes: 
							[
								{
									MemberTypeID: String
								}
							],
							DonationFunds: 
							[
								{
									DonationFundID: String
								}
							],
							MemberTypesProxy: 
							[
								{
									MemberTypeID: String
								}
							],
							Values: 
							[
								{
									Ordinal: 0,
									Text: String,
									Value: String
								}
							],
							ValuesProxy: 
							[
								{
									Ordinal: 0,
									Text: String,
									Value: String
								}
							],
							HelpTopic: 
							{
								ID: 0,
								ClientID: 0,
								Label: String,
								Content: String,
								Width: 0,
								Height: 0
							},
							FieldDataType: String
						}
					],
					Visibility: String,
					VisibilityInt: 2,
					Values: 
					[
						{
							Value: String,
							Text: String
						}
					],
					ValuesProxy: 
					[
						{
							Value: String,
							Text: String
						}
					],
					MetaValue: 
					{
						Value: String,
						Text: String
					},
					ClientID: 0
				}
			]
		}
	],
	TotalMemberFound: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:36:41.2404784-05:00,
	ServerID: WS-5-212-532,
	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: 2025-01-15T08:50:18.6465347-05:00,
	Device: Desktop
}