NAV

<back to all web services

ProfileGet

The following routes are available for this service:
GET/profile/{BeeNumber}
ProfileGet Parameters:
NameParameterData TypeRequiredDescription
BeeNumberpathdecimalNo
ProfileGetResponse Parameters:
NameParameterData TypeRequiredDescription
BeeNumberformdecimalNo
CurrentStatusformstringNo
RemovalReasonformstringNo
PcTagformstringNo
LabcOwnerformdecimalNo
PastDueCodeformstringNo
PastDueAmountformdecimalNo
CreditLimitformdecimalNo
CurrentBalanceformdecimalNo
SelectiveServiceTagformstringNo
NoCode21formstringNo
NoCode30formstringNo
Rep_Acs_indformboolNo
CampaignDoubleDollarsformdecimalNo
CampaignAwardSalesformdecimalNo
CycletoDateDoubleDollarsformdecimalNo
CycletoDateAwardSalesformdecimalNo
PendingOrdersBalanceformdecimalNo
HyperwalletAccountStatusformstringNo
ResponseStatusformResponseStatusNo
AmountDueformdecimal?No
LastPaymentAmountformdecimal?No
LastPaymentDateformDateTime?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 /profile/{BeeNumber} HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	currentStatus: String,
	removalReason: String,
	pcTag: String,
	labcOwner: 0,
	pastDueCode: String,
	pastDueAmount: 0,
	creditLimit: 0,
	currentBalance: 0,
	selectiveServiceTag: String,
	noCode21: String,
	noCode30: String,
	rep_Acs_ind: False,
	campaignDoubleDollars: 0,
	campaignAwardSales: 0,
	cycletoDateDoubleDollars: 0,
	cycletoDateAwardSales: 0,
	pendingOrdersBalance: 0,
	hyperwalletAccountStatus: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	amountDue: 0,
	lastPaymentAmount: 0,
	lastPaymentDate: 0001-01-01T00:00:00
}