NAV

LeadUpgrade

The following routes are available for this service:
POST	/upgrade-lead

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 LeadUpgradeResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVPhoneUpdate:
    number: Optional[str] = None
    extension: Optional[str] = None
    code_id_phone_type: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVAddressUpdate:
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    address_line4: Optional[str] = None
    address_line5: Optional[str] = None
    city: Optional[str] = None
    state_code: Optional[str] = None
    postal_code: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVTermsUpdate:
    version: Optional[str] = None
    date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVCASLTermsUpdate:
    agree: Optional[str] = None
    date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LeadUpgrade(IPost):
    bee_number: Optional[Decimal] = None
    email_address: Optional[str] = None
    mentor_bee_number: Optional[Decimal] = None
    language: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    primary_phone: Optional[NAVPhoneUpdate] = None
    additional_phone: Optional[NAVPhoneUpdate] = None
    billing_address: Optional[NAVAddressUpdate] = None
    shipping_address: Optional[NAVAddressUpdate] = None
    government_id: Optional[str] = None
    terms_agreement: Optional[NAVTermsUpdate] = None
    electronic_agreement: Optional[NAVTermsUpdate] = None
    agent_id: Optional[str] = None
    kit_number: Optional[str] = None
    kit_price: Optional[Decimal] = None
    payment_method: Optional[str] = None
    tax_amount: Optional[Decimal] = None
    donation_amount: Optional[Decimal] = None
    publicity_tag: Optional[str] = None
    e_store_url: Optional[str] = None
    appt_y_y_y_y_c_c: Optional[str] = None
    appt_h_h_m_m_s_s: Optional[str] = None
    appt_y_y_y_y_m_m_d_d: Optional[str] = None
    privacy_policy_agreement: Optional[NAVTermsUpdate] = None
    website_terms_of_use_agreement: Optional[NAVTermsUpdate] = None
    age_verification_agreement: Optional[NAVTermsUpdate] = None
    casl_statement_agreement: Optional[NAVCASLTermsUpdate] = None

Python LeadUpgrade 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.

POST /upgrade-lead HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	emailAddress: String,
	mentorBeeNumber: 0,
	language: String,
	birthDate: 0001-01-01T00:00:00,
	primaryPhone: 
	{
		number: String,
		extension: String,
		codeIdPhoneType: String,
		countryCode: String
	},
	additionalPhone: 
	{
		number: String,
		extension: String,
		codeIdPhoneType: String,
		countryCode: String
	},
	billingAddress: 
	{
		firstName: String,
		lastName: String,
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		addressLine4: String,
		addressLine5: String,
		city: String,
		stateCode: String,
		postalCode: String,
		countryCode: String
	},
	shippingAddress: 
	{
		firstName: String,
		lastName: String,
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		addressLine4: String,
		addressLine5: String,
		city: String,
		stateCode: String,
		postalCode: String,
		countryCode: String
	},
	governmentId: String,
	termsAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	electronicAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	agentId: String,
	kitNumber: String,
	kitPrice: 0,
	paymentMethod: String,
	taxAmount: 0,
	donationAmount: 0,
	publicityTag: String,
	eStoreUrl: String,
	apptYYYYCC: String,
	apptHHMMSS: String,
	apptYYYYMMDD: String,
	privacyPolicyAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	websiteTermsOfUseAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	ageVerificationAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	caslStatementAgreement: 
	{
		agree: String,
		date: 0001-01-01T00:00:00
	}
}

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
		}
	}
}