NAV

<back to all web services

AuthenticationLoginFacebookCreate

The following routes are available for this service:
POST/authentication/facebook-login
AuthenticationLoginFacebookCreate Parameters:
NameParameterData TypeRequiredDescription
FacebookIdbodystringNo
AuthenticationLoginFacebookCreateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AccessTokenformstringNo
RefreshTokenformstringNo
MrktCdformstringNo
TimestampformDateTime?No
DataformLoginResponseDataNo
LoginResponseData Parameters:
NameParameterData TypeRequiredDescription
AcctNrformdecimal?No
AcctStusCdformstringNo
AcctTypformstringNo
EmailAddrTxtformstringNo
EvngPhonNrformstringNo
FrstNmformstringNo
LangCdformstringNo
LastNmformstringNo
MddlNmformstringNo
CurrSlsCmpgnNrformint?No
CurrSlsYrNrformint?No
AddressesformList<Address>No
LoaNrformint?No
RepClubLvlCdformstringNo
CampaignsformList<Campaign>No
CampaignEndDtformDateTime?No
VanityNameformstringNo
CurrBalAmtformdecimalNo
RepClubTypesformList<RepClubType>No
PrfrdNmformstringNo
RepEnrlmentsformList<RepEnrlment>No
OrdDueDtformDateTime?No
ShpngDtformDateTime?No
CmpgnEndDtformDateTime?No
CmpgnStrtDtformDateTime?No
OnlnOrdSbmsnDtformDateTime?No
CurrentDtTimeformDateTime?No
DaysLeftformstringNo
TimeZoneformstringNo
PswrdHintformstringNo
MentorNameformstringNo
MentorPhonNbrformstringNo
MentorStCdformstringNo
MentorCityNmformstringNo
MentorEmailformstringNo
LdrShipLvlformstringNo
RepMgrEmailformstringNo
ApptDtformDateTime?No
CrdtScrCdformstringNo
DstrbtnCntrCdformstringNo
EltrtrCdformstringNo
InitCmpgnNrformint?No
InitCmpgnYrNrformint?No
LabcIndformstringNo
PastDueStusCdformstringNo
PrsdntClubStusCdformstringNo
ShpngFcltyCdformstringNo
TierCdformstringNo
TrckRouteCdformstringNo
RepCustCountformint?No
SsnformstringNo
CreditLimitformint?No
IsFbLinkedformstringNo
DeliveryTypeListformList<Delivery>No
BrthdyDtformDateTime?No
Address Parameters:
NameParameterData TypeRequiredDescription
AddrLocTypformstringNo
AddrCityNmformstringNo
AddrCntryCdformstringNo
AddrLine1TxtformstringNo
AddrStCdformstringNo
AddrZipCdformstringNo
Campaign Parameters:
NameParameterData TypeRequiredDescription
MrktIdformint?No
Successformbool?No
CmpgnYrNrformint?No
CmpgnNrformint?No
RepClubType Parameters:
NameParameterData TypeRequiredDescription
RepClubTypCdformstringNo
PrsdntClubIndformstringNo
RepEnrlment Parameters:
NameParameterData TypeRequiredDescription
EnrldTypformstringNo
EnrlmtStusCdformstringNo
Delivery Parameters:
NameParameterData TypeRequiredDescription
DeliveryTypeformstringNo
DeliveryLabelformstringNo
DeliveryFromDtformDateTime?No
DeliveryToDtformDateTime?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 /authentication/facebook-login HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	facebookId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	accessToken: String,
	refreshToken: String,
	mrktCd: String,
	timestamp: 0001-01-01T00:00:00,
	data: 
	{
		AcctNr: 0,
		AcctStusCd: String,
		AcctTyp: String,
		EmailAddrTxt: String,
		EvngPhonNr: String,
		FrstNm: String,
		LangCd: String,
		LastNm: String,
		MddlNm: String,
		CurrSlsCmpgnNr: 0,
		CurrSlsYrNr: 0,
		Addresses: 
		[
			{
				addrLocTyp: String,
				addrCityNm: String,
				addrCntryCd: String,
				addrLine1Txt: String,
				addrStCd: String,
				addrZipCd: String
			}
		],
		LoaNr: 0,
		RepClubLvlCd: String,
		Campaigns: 
		[
			{
				MrktId: 0,
				Success: False,
				CmpgnYrNr: 0,
				CmpgnNr: 0
			}
		],
		CampaignEndDt: 0001-01-01T00:00:00,
		VanityName: String,
		CurrBalAmt: 0,
		RepClubTypes: 
		[
			{
				RepClubTypCd: String,
				PrsdntClubInd: String
			}
		],
		PrfrdNm: String,
		RepEnrlments: 
		[
			{
				EnrldTyp: String,
				EnrlmtStusCd: String
			}
		],
		OrdDueDt: 0001-01-01T00:00:00,
		ShpngDt: 0001-01-01T00:00:00,
		CmpgnEndDt: 0001-01-01T00:00:00,
		CmpgnStrtDt: 0001-01-01T00:00:00,
		OnlnOrdSbmsnDt: 0001-01-01T00:00:00,
		CurrentDtTime: 0001-01-01T00:00:00,
		DaysLeft: String,
		TimeZone: String,
		PswrdHint: String,
		MentorName: String,
		MentorPhonNbr: String,
		MentorStCd: String,
		MentorCityNm: String,
		MentorEmail: String,
		LdrShipLvl: String,
		RepMgrEmail: String,
		ApptDt: 0001-01-01T00:00:00,
		CrdtScrCd: String,
		DstrbtnCntrCd: String,
		EltrtrCd: String,
		InitCmpgnNr: 0,
		InitCmpgnYrNr: 0,
		LabcInd: String,
		PastDueStusCd: String,
		PrsdntClubStusCd: String,
		ShpngFcltyCd: String,
		TierCd: String,
		TrckRouteCd: String,
		RepCustCount: 0,
		Ssn: String,
		CreditLimit: 0,
		IsFbLinked: String,
		DeliveryTypeList: 
		[
			{
				DeliveryType: String,
				DeliveryLabel: String,
				DeliveryFromDt: 0001-01-01T00:00:00,
				DeliveryToDt: 0001-01-01T00:00:00
			}
		],
		BrthdyDt: 0001-01-01T00:00:00
	}
}