YM REST Services

<back to all web services

MemberProfile

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/MemberProfileReturn the logged on member's profile.
PUT/Ams/{ClientID}/Member/{MemberID}/MemberProfileUpdate the logged on member's profile.
GET/Ams/{ClientID}/Member/{MemberID}/MemberProfile/{ProfileID}Return another member's profile.
MemberProfile Parameters:
NameParameterData TypeRequiredDescription
AccountInformationbodyAccountInformationNo
AdministrationbodyAdministrationNo
PersonalInformationbodyPersonalInformationNo
ProfessionalInformationbodyProfessionalInformationNo
AdditionalInformationbodyAdditionalInformationNo
ProfileIDpathintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
AccountInformation Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNo
PasswordformstringNo
MembershipIDformintNo
MembershipExpiresformboolNo
MembershipExpiresDateformDateTimeNo
SubordinateSeatsformintNo
JobPostingsformintNo
MemberPageMaxformintNo
ConstituentIDformstringNo
InternalCommentsformstringNo
MemberTypeCodeformstringNo
ProfileIDformintNo
RegisteredformDateTimeNo
CdbGUIDformstringNo
MembershipformstringNo
LastRenewalDateformDateTimeNo
LastRenewalReminderSentformDateTimeNo
MemberProfilePublicformboolNo
PrimaryGroupNameformstringNo
PrimaryGroupIDformintNo
PrimaryGroupCodeformstringNo
LastUpdatedformDateTimeNo
Administration Parameters:
NameParameterData TypeRequiredDescription
ApprovedformboolNo
FeaturedformboolNo
FeatureTextformstringNo
ApprovalDateformDateTimeNo
SuspendedformboolNo
EmailBouncedformboolNo
cdlAdminClassYearsformstringNo
PersonalInformation Parameters:
NameParameterData TypeRequiredDescription
GenderformstringNo
PrefixformstringNo
FirstNameformstringNo
MiddleNameformstringNo
MiddleInitialformstringNo
LastNameformstringNo
SuffixformstringNo
NickNameformstringNo
MaidenNameformstringNo
SpouseNameformstringNo
MaritalStatusformstringNo
AnniversaryDateformDateTimeNo
BirthdayDateformDateTimeNo
HomeUrlformstringNo
HomeAddressLine1formstringNo
HomeAddressLine2formstringNo
HomeAddressCityformstringNo
HomeAddressLocationformstringNo
HomeAddressPostalCodeformstringNo
HomeAddressCountryformstringNo
HomePhoneCountryCodeformstringNo
HomePhoneAreaCodeformstringNo
HomePhoneNumberformstringNo
HomeFaxNumberformstringNo
HomeFaxCountryCodeformstringNo
HomeFaxAreaCodeformstringNo
EmailformstringNo
EmailAltformstringNo
IMNameformstringNo
IMTypeformstringNo
HeadshotImageformstringNo
HeadshotImageURIformstringNo
FullNameformstringNo
ProfessionalInformation Parameters:
NameParameterData TypeRequiredDescription
EmployerNameformstringNo
SelfEmployedformboolNo
WorkTitleformstringNo
WorkTypeformstringNo
WorkUrlformstringNo
WorkAddressLine1formstringNo
WorkAddressLine2formstringNo
WorkAddressCityformstringNo
WorkAddressLocationformstringNo
WorkAddressPostalCodeformstringNo
WorkAddressCountryformstringNo
WorkPhoneCountryCodeformstringNo
WorkPhoneNumberformstringNo
WorkPhoneAreaCodeformstringNo
WorkFaxCountryCodeformstringNo
WorkFaxNumberformstringNo
WorkFaxAreaCodeformstringNo
CustomFieldValuesformCustomFieldResponsesNo
CustomFieldResponse Parameters:
NameParameterData TypeRequiredDescription
FieldCodeformstringNo
FieldsformCustomFieldsNo
VisibilityformstringNo
VisibilityIntformintNo
ValuesformList<CustomFieldResponseValue>No
ValuesProxyformArrayListNo
MetaValueformCustomFieldResponseValueNo
ClientIDformintNo
CustomField Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
FieldTypeformCustomFieldTypeNo
GroupCodeformstringNo
GroupCodeFriendlyformstringNo
RequiredformboolNo
VisibleformintNo
MemberCanOverrideformboolNo
EditableformintNo
SearchableformboolNo
OrdinalformintNo
MaxLengthformintNo
IsMultiSelectformboolNo
IsFIBformboolNo
IsFileUploadformboolNo
LabelformstringNo
CodeformstringNo
ExportLabelformstringNo
SearchLabelformstringNo
SearchInfoformstringNo
DescriptionformstringNo
ValidationExpressionformstringNo
MemberTypesformList<CustomFieldMemberType>No
DonationFundsformList<CustomFieldDonationFund>No
MemberTypesProxyformArrayListNo
ValuesformList<CustomFieldValue>No
ValuesProxyformArrayListNo
HelpTopicformCustomHelpNo
FieldDataTypeformFieldTypesNo
CustomFieldMemberType Parameters:
NameParameterData TypeRequiredDescription
MemberTypeIDformstringNo
CustomFieldDonationFund Parameters:
NameParameterData TypeRequiredDescription
DonationFundIDformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
OrdinalformintNo
TextformstringNo
ValueformstringNo
CustomHelp Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ClientIDformintNo
LabelformstringNo
ContentformstringNo
WidthformintNo
HeightformintNo
CustomFieldResponseValue Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
TextformstringNo
AdditionalInformation Parameters:
NameParameterData TypeRequiredDescription
PersonalCommentsformstringNo
AdditionalEduformstringNo
SocialOrgsformstringNo
ConnectionStatusformConnectionStatusNo
IsAmbassadorformboolNo
GamificationPointsformdouble?No
PreferredAddressLatitudeformdecimalNo
PreferredAddressLongitudeformdecimalNo
MemberProfileResponse Parameters:
NameParameterData TypeRequiredDescription
ReadOnlyPropertiesformReadOnlyPropertiesNo
DisplayOptionsformDisplayOptionsNo
ReadOnlyProperties Parameters:
NameParameterData TypeRequiredDescription
AccessFolderformintNo
AccessGranularformintNo
canMemberMaintainFileLibraryformboolNo
CanAdminMembersformboolNo
CanMaintainNetworksformboolNo
CanMaintainMyNetworksformboolNo
CanUploadMediaformboolNo
CanHaveWeblogformboolNo
CanHavePermEmailformboolNo
CanHaveBuddyListformboolNo
CanPostToForumformboolNo
CanPostGroupNoteformboolNo
CanBulkEmailGroupformboolNo
CanHaveResumeformboolNo
CanUseMessagingformboolNo
CanAdminContactsformboolNo
CanAdminBlogsformboolNo
CanPostJobOpeningsformboolNo
CanSearchResumesformboolNo
CanSearchJobsformboolNo
CanDetachSubAccountsformboolNo
CanMaintainFileLibraryformboolNo
CanUploadHeadshotformboolNo
CanHaveFavoritesformboolNo
CanMaintainWallformboolNo
CanHaveProfilePagesformboolNo
CanViewMembershipformboolNo
CanHaveSubscriptionsformboolNo
HasAccessToGroupsformboolNo
HasWallformboolNo
PrimaryAddressTypeformstringNo
NameFormatShortformintNo
NameFormatNormalformintNo
NameFormatLongformintNo
NameFormatDirSortformintNo
GameLevelformstringNo
DaysUntilMembershipExpiresformint?No
DaysSinceMembershipExpiredformint?No
MembershipEffectiveExpiresDateformDateTimeNo
MembershipEffectiveExpiresformboolNo
AddressOptionListForPersonformstringNo
CustomFieldValuesformCustomFieldResponsesNo
SubAccountsformintNo
PendingConnectionsformintNo
UnreadMessagesformintNo
DisplayOptions Parameters:
NameParameterData TypeRequiredDescription
ShowOnlineNowformboolNo
ShowOrganizationformboolNo
ShowMessageButtonformboolNo
ShowConnectButtonformboolNo
ShowIMUsernameformboolNo
ShowNickNameformboolNo
ShowMaidenNameformboolNo
ShowBirthdayDateformboolNo
ShowMarriageStatusformboolNo
ShowWeddingDateformboolNo
ShowSpouseformboolNo
ShowPrimaryEmailformboolNo
ShowHomeAddressformboolNo
ShowHomeAddress2formboolNo
ShowHomeCityformboolNo
ShowHomeZipformboolNo
ShowHomePhoneformboolNo
ShowHomeFaxformboolNo
ShowWorkAddressformboolNo
ShowWorkAddress2formboolNo
ShowWorkCityformboolNo
ShowWorkZipformboolNo
ShowWorkPhoneformboolNo
ShowWorkFaxformboolNo
ShowEmployerNameformboolNo
ShowEmployerTitleformboolNo
ShowEmployerLocationformboolNo
ShowEmployerOwnsBusinessformboolNo
ShowHomeCountryformboolNo
ShowHomeLocationformboolNo
ShowWorkCountryformboolNo
ShowResumeformboolNo
ProfilePhotoformboolNo
ShowGameBadgeformboolNo

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.

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

{
	AccountInformation: 
	{
		UserName: String,
		Password: String,
		MembershipID: 0,
		MembershipExpires: False,
		MembershipExpiresDate: 0001-01-01,
		SubordinateSeats: 0,
		JobPostings: 0,
		MemberPageMax: 0,
		ConstituentID: String,
		InternalComments: String,
		MemberTypeCode: String,
		ProfileID: 0,
		Registered: 0001-01-01,
		CdbGUID: String,
		Membership: String,
		LastRenewalDate: 0001-01-01,
		LastRenewalReminderSent: 0001-01-01,
		MemberProfilePublic: False,
		PrimaryGroupName: String,
		PrimaryGroupID: 0,
		PrimaryGroupCode: String,
		LastUpdated: 0001-01-01
	},
	Administration: 
	{
		Approved: False,
		Featured: False,
		FeatureText: String,
		ApprovalDate: 0001-01-01,
		Suspended: False,
		EmailBounced: False,
		cdlAdminClassYears: String
	},
	PersonalInformation: 
	{
		Gender: String,
		Prefix: String,
		FirstName: String,
		MiddleName: String,
		MiddleInitial: 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,
		IMName: String,
		IMType: String,
		HeadshotImage: String,
		HeadshotImageURI: String,
		FullName: String
	},
	ProfessionalInformation: 
	{
		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,
		WorkFaxCountryCode: String,
		WorkFaxNumber: String,
		WorkFaxAreaCode: String,
		CustomFieldValues: 
		[
			{
				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
			}
		]
	},
	AdditionalInformation: 
	{
		PersonalComments: String,
		AdditionalEdu: String,
		SocialOrgs: String,
		ConnectionStatus: None,
		IsAmbassador: False,
		GamificationPoints: 0,
		PreferredAddressLatitude: 0,
		PreferredAddressLongitude: 0
	},
	ProfileID: 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: 2024-05-03T09:34:08.5958899-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReadOnlyProperties: 
	{
		AccessFolder: 0,
		AccessGranular: 0,
		canMemberMaintainFileLibrary: False,
		CanAdminMembers: False,
		CanMaintainNetworks: False,
		CanMaintainMyNetworks: False,
		CanUploadMedia: False,
		CanHaveWeblog: False,
		CanHavePermEmail: False,
		CanHaveBuddyList: False,
		CanPostToForum: False,
		CanPostGroupNote: False,
		CanBulkEmailGroup: False,
		CanHaveResume: False,
		CanUseMessaging: False,
		CanAdminContacts: False,
		CanAdminBlogs: False,
		CanPostJobOpenings: False,
		CanSearchResumes: False,
		CanSearchJobs: False,
		CanDetachSubAccounts: False,
		CanMaintainFileLibrary: False,
		CanUploadHeadshot: False,
		CanHaveFavorites: False,
		CanMaintainWall: False,
		CanHaveProfilePages: False,
		CanViewMembership: False,
		CanHaveSubscriptions: False,
		HasAccessToGroups: False,
		HasWall: False,
		PrimaryAddressType: String,
		NameFormatShort: 0,
		NameFormatNormal: 0,
		NameFormatLong: 0,
		NameFormatDirSort: 0,
		GameLevel: String,
		DaysUntilMembershipExpires: 0,
		DaysSinceMembershipExpired: 0,
		MembershipEffectiveExpiresDate: 0001-01-01,
		MembershipEffectiveExpires: False,
		AddressOptionListForPerson: String,
		CustomFieldValues: 
		[
			{
				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
			}
		],
		SubAccounts: 0,
		PendingConnections: 0,
		UnreadMessages: 0
	},
	DisplayOptions: 
	{
		ShowOnlineNow: False,
		ShowOrganization: False,
		ShowMessageButton: False,
		ShowConnectButton: False,
		ShowIMUsername: False,
		ShowNickName: False,
		ShowMaidenName: False,
		ShowBirthdayDate: False,
		ShowMarriageStatus: False,
		ShowWeddingDate: False,
		ShowSpouse: False,
		ShowPrimaryEmail: False,
		ShowHomeAddress: False,
		ShowHomeAddress2: False,
		ShowHomeCity: False,
		ShowHomeZip: False,
		ShowHomePhone: False,
		ShowHomeFax: False,
		ShowWorkAddress: False,
		ShowWorkAddress2: False,
		ShowWorkCity: False,
		ShowWorkZip: False,
		ShowWorkPhone: False,
		ShowWorkFax: False,
		ShowEmployerName: False,
		ShowEmployerTitle: False,
		ShowEmployerLocation: False,
		ShowEmployerOwnsBusiness: False,
		ShowHomeCountry: False,
		ShowHomeLocation: False,
		ShowWorkCountry: False,
		ShowResume: False,
		ProfilePhoto: False,
		ShowGameBadge: False
	},
	AccountInformation: 
	{
		UserName: String,
		Password: String,
		MembershipID: 0,
		MembershipExpires: False,
		MembershipExpiresDate: 0001-01-01,
		SubordinateSeats: 0,
		JobPostings: 0,
		MemberPageMax: 0,
		ConstituentID: String,
		InternalComments: String,
		MemberTypeCode: String,
		ProfileID: 0,
		Registered: 0001-01-01,
		CdbGUID: String,
		Membership: String,
		LastRenewalDate: 0001-01-01,
		LastRenewalReminderSent: 0001-01-01,
		MemberProfilePublic: False,
		PrimaryGroupName: String,
		PrimaryGroupID: 0,
		PrimaryGroupCode: String,
		LastUpdated: 0001-01-01
	},
	Administration: 
	{
		Approved: False,
		Featured: False,
		FeatureText: String,
		ApprovalDate: 0001-01-01,
		Suspended: False,
		EmailBounced: False,
		cdlAdminClassYears: String
	},
	PersonalInformation: 
	{
		Gender: String,
		Prefix: String,
		FirstName: String,
		MiddleName: String,
		MiddleInitial: 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,
		IMName: String,
		IMType: String,
		HeadshotImage: String,
		HeadshotImageURI: String,
		FullName: String
	},
	ProfessionalInformation: 
	{
		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,
		WorkFaxCountryCode: String,
		WorkFaxNumber: String,
		WorkFaxAreaCode: String,
		CustomFieldValues: 
		[
			{
				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
			}
		]
	},
	AdditionalInformation: 
	{
		PersonalComments: String,
		AdditionalEdu: String,
		SocialOrgs: String,
		ConnectionStatus: None,
		IsAmbassador: False,
		GamificationPoints: 0,
		PreferredAddressLatitude: 0,
		PreferredAddressLongitude: 0
	},
	ProfileID: 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: 2024-05-03T09:34:08.6218916-04:00,
	Device: Desktop
}