YM REST Services

MembersProfiles

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

The following routes are available for this service:
GET	/Ams/{ClientID}/MembersProfiles	Return all members' profiles.

**MembersProfiles** Parameters:
Name	Parameter	Data Type	Required
IncludeCustomFields	query	bool	No
FilterByDateTime	query	DateTime?	No
PageNumber	query	int	No
PageSize	query	int	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

**MembersProfilesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
MembersProfilesList	form	List<MemberProfileData>	No
MembersProfilesCount	form	int	No

**MemberProfileData** Parameters:
Name	Parameter	Data Type	Required
WebSiteMemberID	form	int	No
MasterMemberID	form	int?	No
ConstituentID	form	string	No
RegistrationDate	form	DateTime?	No
ApprovedSiteMember	form	bool	No
DateApproved	form	DateTime?	No
DateLastLogin	form	DateTime?	No
MemberSuspended	form	bool	No
LastUpdated	form	DateTime?	No
DateMembershipExpires	form	DateTime?	No
Membership	form	string	No
HasDonatedOnline	form	bool	No
DateLastDonated	form	DateTime?	No
HasPurchasedOnline	form	bool	No
DateLastPurchased	form	DateTime?	No
HasRegisteredEventOnline	form	bool	No
DateLastEventReg	form	DateTime?	No
Username	form	string	No
Password	form	string	No
MemberTypeCode	form	string	No
PrimaryGroupCode	form	string	No
Gender	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
Nickname	form	string	No
MemberNameSuffix	form	string	No
MemberNameTitle	form	string	No
Birthdate	form	DateTime?	No
MarriageStatus	form	string	No
MaidenName	form	string	No
AnniversaryDate	form	DateTime?	No
SpouseName	form	string	No
EmailAddress	form	string	No
EmailAddressAlternate	form	string	No
EmailBounced	form	bool	No
MessengerType	form	string	No
MessengerHandle	form	string	No
HomeAddressLine1	form	string	No
HomeAddressLine2	form	string	No
HomeCity	form	string	No
HomeLocation	form	string	No
HomeStateAbbrev	form	string	No
HomePostalCode	form	string	No
HomeCountry	form	string	No
PersonalWebsite	form	string	No
HomePhoneAreaCode	form	string	No
HomePhone	form	string	No
MobileAreaCode	form	string	No
MobilePhone	form	string	No
EmployerName	form	string	No
ProfessionalTitle	form	string	No
Profession	form	string	No
EmployerAddressLine1	form	string	No
EmployerAddressLine2	form	string	No
EmployerCity	form	string	No
EmployerLocation	form	string	No
EmployerStateAbbrev	form	string	No
EmployerPostalCode	form	string	No
EmployerCountry	form	string	No
EmployerWebsite	form	string	No
EmployerPhoneAreaCode	form	string	No
EmployerPhone	form	string	No
EmployerFaxAreaCode	form	string	No
EmployerFax	form	string	No
ResumeExists	form	bool	No
ResumeHeadline	form	string	No
SocialOrganizations	form	string	No
EducationAndExperience	form	string	No
MorePersonalInfo	form	string	No
InternalComments	form	string	No
HomeAddressValidated	form	bool	No
EmployerAddressValidated	form	bool	No
DateLastRenewed	form	DateTime?	No
DateEffectiveMembershipExpires	form	DateTime?	No
ImportBatchID	form	int?	No
CareerOpeningsAllowed	form	int?	No
MembersPagesAllowed	form	int?	No
AdditionalSeatsAllowed	form	int?	No
NameFormatNormal	form	int?	No
MemberHasConsented	form	bool?	No
DateConsented	form	DateTime?	No
ConsentIPAddress	form	string	No
MemberHasRevokedConsent	form	bool?	No
DateConsentRevoked	form	DateTime?	No
CustomFields	form	List<CustomFld>	No

**CustomFld** Parameters:
Name	Parameter	Data Type	Required	Description
ExportLabel	form	string	No
CustomFieldValue	form	CustomFieldResponse	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}/MembersProfiles HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	MembersProfilesList: 
	[
		{
			WebSiteMemberID: 0,
			MasterMemberID: 0,
			ConstituentID: String,
			RegistrationDate: 0001-01-01,
			ApprovedSiteMember: False,
			DateApproved: 0001-01-01,
			DateLastLogin: 0001-01-01,
			MemberSuspended: False,
			LastUpdated: 0001-01-01,
			DateMembershipExpires: 0001-01-01,
			Membership: String,
			HasDonatedOnline: False,
			DateLastDonated: 0001-01-01,
			HasPurchasedOnline: False,
			DateLastPurchased: 0001-01-01,
			HasRegisteredEventOnline: False,
			DateLastEventReg: 0001-01-01,
			Username: String,
			Password: String,
			MemberTypeCode: String,
			PrimaryGroupCode: String,
			Gender: String,
			FirstName: String,
			MiddleName: String,
			LastName: String,
			Nickname: String,
			MemberNameSuffix: String,
			MemberNameTitle: String,
			Birthdate: 0001-01-01,
			MarriageStatus: String,
			MaidenName: String,
			AnniversaryDate: 0001-01-01,
			SpouseName: String,
			EmailAddress: String,
			EmailAddressAlternate: String,
			EmailBounced: False,
			MessengerType: String,
			MessengerHandle: String,
			HomeAddressLine1: String,
			HomeAddressLine2: String,
			HomeCity: String,
			HomeLocation: String,
			HomeStateAbbrev: String,
			HomePostalCode: String,
			HomeCountry: String,
			PersonalWebsite: String,
			HomePhoneAreaCode: String,
			HomePhone: String,
			MobileAreaCode: String,
			MobilePhone: String,
			EmployerName: String,
			ProfessionalTitle: String,
			Profession: String,
			EmployerAddressLine1: String,
			EmployerAddressLine2: String,
			EmployerCity: String,
			EmployerLocation: String,
			EmployerStateAbbrev: String,
			EmployerPostalCode: String,
			EmployerCountry: String,
			EmployerWebsite: String,
			EmployerPhoneAreaCode: String,
			EmployerPhone: String,
			EmployerFaxAreaCode: String,
			EmployerFax: String,
			ResumeExists: False,
			ResumeHeadline: String,
			SocialOrganizations: String,
			EducationAndExperience: String,
			MorePersonalInfo: String,
			InternalComments: String,
			HomeAddressValidated: False,
			EmployerAddressValidated: False,
			DateLastRenewed: 0001-01-01,
			DateEffectiveMembershipExpires: 0001-01-01,
			ImportBatchID: 0,
			CareerOpeningsAllowed: 0,
			MembersPagesAllowed: 0,
			AdditionalSeatsAllowed: 0,
			NameFormatNormal: 0,
			MemberHasConsented: False,
			DateConsented: 0001-01-01,
			ConsentIPAddress: String,
			MemberHasRevokedConsent: False,
			DateConsentRevoked: 0001-01-01,
			CustomFields: 
			[
				{
					ExportLabel: String,
					CustomFieldValue: 
					{
						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
					}
				}
			]
		}
	],
	MembersProfilesCount: 0,
	IncludeCustomFields: False,
	FilterByDateTime: 0001-01-01,
	PageNumber: 0,
	PageSize: 0,
	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: 2025-01-15T08:39:21.2392675-05:00,
	Device: Desktop
}