NAV

<back to all web services

ProfileGet

The following routes are available for this service:
GET/profile/{BeeNumber}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileGetResponse:
    bee_number: Optional[Decimal] = None
    current_status: Optional[str] = None
    removal_reason: Optional[str] = None
    pc_tag: Optional[str] = None
    labc_owner: Optional[Decimal] = None
    past_due_code: Optional[str] = None
    past_due_amount: Optional[Decimal] = None
    credit_limit: Optional[Decimal] = None
    current_balance: Optional[Decimal] = None
    selective_service_tag: Optional[str] = None
    no_code21: Optional[str] = None
    no_code30: Optional[str] = None
    rep__acs_ind: Optional[bool] = None
    campaign_double_dollars: Optional[Decimal] = None
    campaign_award_sales: Optional[Decimal] = None
    cycleto_date_double_dollars: Optional[Decimal] = None
    cycleto_date_award_sales: Optional[Decimal] = None
    pending_orders_balance: Optional[Decimal] = None
    hyperwallet_account_status: Optional[str] = None
    response_status: Optional[ResponseStatus] = None
    amount_due: Optional[Decimal] = None
    last_payment_amount: Optional[Decimal] = None
    last_payment_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileGet(IGet):
    bee_number: Optional[Decimal] = None

Python ProfileGet DTOs

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
}