NAV

LeadUpgrade

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


export class LeadUpgradeResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<LeadUpgradeResponse>) { (Object as any).assign(this, init); }
}

export class NAVPhoneUpdate
{
    public number?: string;
    public extension?: string;
    public codeIdPhoneType?: string;
    public countryCode?: string;

    public constructor(init?: Partial<NAVPhoneUpdate>) { (Object as any).assign(this, init); }
}

export class NAVAddressUpdate
{
    public firstName?: string;
    public lastName?: string;
    public addressLine1?: string;
    public addressLine2?: string;
    public addressLine3?: string;
    public addressLine4?: string;
    public addressLine5?: string;
    public city?: string;
    public stateCode?: string;
    public postalCode?: string;
    public countryCode?: string;

    public constructor(init?: Partial<NAVAddressUpdate>) { (Object as any).assign(this, init); }
}

export class NAVTermsUpdate
{
    public version?: string;
    public date?: string;

    public constructor(init?: Partial<NAVTermsUpdate>) { (Object as any).assign(this, init); }
}

export class NAVCASLTermsUpdate
{
    public agree?: string;
    public date?: string;

    public constructor(init?: Partial<NAVCASLTermsUpdate>) { (Object as any).assign(this, init); }
}

export class LeadUpgrade implements IPost
{
    public beeNumber?: number;
    public emailAddress?: string;
    public mentorBeeNumber?: number;
    public language?: string;
    public birthDate?: string;
    public primaryPhone?: NAVPhoneUpdate;
    public additionalPhone?: NAVPhoneUpdate;
    public billingAddress?: NAVAddressUpdate;
    public shippingAddress?: NAVAddressUpdate;
    public governmentId?: string;
    public termsAgreement?: NAVTermsUpdate;
    public electronicAgreement?: NAVTermsUpdate;
    public agentId?: string;
    public kitNumber?: string;
    public kitPrice?: number;
    public paymentMethod?: string;
    public taxAmount?: number;
    public donationAmount?: number;
    public publicityTag?: string;
    public eStoreUrl?: string;
    public apptYYYYCC?: string;
    public apptHHMMSS?: string;
    public apptYYYYMMDD?: string;
    public privacyPolicyAgreement?: NAVTermsUpdate;
    public websiteTermsOfUseAgreement?: NAVTermsUpdate;
    public ageVerificationAgreement?: NAVTermsUpdate;
    public caslStatementAgreement?: NAVCASLTermsUpdate;

    public constructor(init?: Partial<LeadUpgrade>) { (Object as any).assign(this, init); }
}

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