YM REST Services

Auth

The following routes are available for this service:
POST, OPTIONS	/Ams/Authenticate/{Token}
POST	/Ams/Authenticate

**Auth** Parameters:
Name	Parameter	Data Type	Required	Description
ConsumerKey	body	string	No
ConsumerSecret	body	string	No
AccessToken	body	string	No
Token	path	string	No
ClientID	body	int	No
UserType	body	AuthUserType	No	Allowable Values Anonymous Admin Member
Username	body	string	No
Password	body	string	No
EmailAddress	body	string	No
IncludeMemberConfig	body	bool	No
IncludeExchangeToken	body	bool	No
IncludeBrandingConfig	body	bool	No
Device	body	Device	No	Allowable Values Desktop IOS Android

**AuthResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ClientID	form	int	No
MemberID	form	int	No
FailedLoginReason	form	FailedLoginReason	No	Allowable Values None MultipleAccounts InvalidCredentials AccountLockedOut AccountSuspended AccountPendingApproval InvalidClient InvalidToken ConsentRequired
MemberConfig	form	MemberConfigResponse	No
BrandingConfig	form	BrandingConfigResponse	No
ExchangeToken	form	string	No

**AuthenticateResponse** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
SessionId	form	string	No
UserName	form	string	No
DisplayName	form	string	No
ReferrerUrl	form	string	No
BearerToken	form	string	No
RefreshToken	form	string	No
ResponseStatus	form	ResponseStatus	No
Meta	form	Dictionary<string, string>	No

**MemberConfigResponse** Parameters:
Name	Parameter	Data Type	Required
Locale	form	string	No
DateFormat	form	string	No
CurrencyDecimalSeparator	form	string	No
CurrencyGroupSeparator	form	string	No
CurrencySymbol	form	string	No
CurrencyPositivePattern	form	string	No
CurrencyNegativePattern	form	string	No
SiteUrl	form	string	No
CareersID	form	int	No
ClientNameMobile	form	string	No
FullName	form	string	No
SecureUrl	form	string	No
QuickLinksCount	form	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

**BrandingConfig** Parameters:
Name	Parameter	Data Type	Required	Description
Options	form	Dictionary<string, string>	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	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.

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

{
	ConsumerKey: String,
	ConsumerSecret: String,
	AccessToken: String,
	Token: String,
	ClientID: 0,
	UserType: Anonymous,
	Username: String,
	Password: String,
	EmailAddress: String,
	IncludeMemberConfig: False,
	IncludeExchangeToken: False,
	IncludeBrandingConfig: False,
	Device: Desktop
}

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

{
	ClientID: 0,
	MemberID: 0,
	FailedLoginReason: None,
	MemberConfig: 
	{
		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-03T07:12:44.9481800-04:00,
		Device: Desktop
	},
	BrandingConfig: 
	{
		Options: 
		{
			String: String
		},
		UsingRedis: True,
		AppInitTime: 2024-05-03T05:23:12.6024055-04:00,
		ServerID: WS-6-134-823,
		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-03T07:12:44.9501793-04:00,
		Device: Desktop
	},
	ExchangeToken: String,
	UserId: String,
	SessionId: String,
	UserName: String,
	DisplayName: String,
	ReferrerUrl: String,
	BearerToken: String,
	RefreshToken: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Meta: 
	{
		String: String
	}
}

YM REST Services

Auth

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV