YM REST Services

<back to all web services

MemberConfig

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/ConfigRetrieve member configuration information for use client-side.
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MemberConfigResponse Parameters:
NameParameterData TypeRequiredDescription
LocaleformstringNo
DateFormatformstringNo
CurrencyDecimalSeparatorformstringNo
CurrencyGroupSeparatorformstringNo
CurrencySymbolformstringNo
CurrencyPositivePatternformstringNo
CurrencyNegativePatternformstringNo
SiteUrlformstringNo
CareersIDformintNo
ClientNameMobileformstringNo
FullNameformstringNo
SecureUrlformstringNo
QuickLinksCountformintNo

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}/Member/{MemberID}/Config HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Locale: String,
	DateFormat: String,
	CurrencyDecimalSeparator: String,
	CurrencyGroupSeparator: String,
	CurrencySymbol: String,
	CurrencyPositivePattern: String,
	CurrencyNegativePattern: String,
	SiteUrl: String,
	CareersID: 0,
	ClientNameMobile: String,
	FullName: String,
	SecureUrl: String,
	QuickLinksCount: 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-03T01:02:31.9783660-04:00,
	Device: Desktop
}