NAV

<back to all web services

LeadUpgrade

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

public class LeadUpgrade : IPost, Codable
{
    public var beeNumber:Double?
    public var emailAddress:String?
    public var mentorBeeNumber:Double?
    public var language:String?
    public var birthDate:Date?
    public var primaryPhone:NAVPhoneUpdate?
    public var additionalPhone:NAVPhoneUpdate?
    public var billingAddress:NAVAddressUpdate?
    public var shippingAddress:NAVAddressUpdate?
    public var governmentId:String?
    public var termsAgreement:NAVTermsUpdate?
    public var electronicAgreement:NAVTermsUpdate?
    public var agentId:String?
    public var kitNumber:String?
    public var kitPrice:Double?
    public var paymentMethod:String?
    public var taxAmount:Double?
    public var donationAmount:Double?
    public var publicityTag:String?
    public var eStoreUrl:String?
    public var apptYYYYCC:String?
    public var apptHHMMSS:String?
    public var apptYYYYMMDD:String?
    public var privacyPolicyAgreement:NAVTermsUpdate?
    public var websiteTermsOfUseAgreement:NAVTermsUpdate?
    public var ageVerificationAgreement:NAVTermsUpdate?
    public var caslStatementAgreement:NAVCASLTermsUpdate?

    required public init(){}
}

public class NAVPhoneUpdate : Codable
{
    public var number:String?
    public var `extension`:String?
    public var codeIdPhoneType:String?
    public var countryCode:String?

    required public init(){}
}

public class NAVAddressUpdate : Codable
{
    public var firstName:String?
    public var lastName:String?
    public var addressLine1:String?
    public var addressLine2:String?
    public var addressLine3:String?
    public var addressLine4:String?
    public var addressLine5:String?
    public var city:String?
    public var stateCode:String?
    public var postalCode:String?
    public var countryCode:String?

    required public init(){}
}

public class NAVTermsUpdate : Codable
{
    public var version:String?
    public var date:Date?

    required public init(){}
}

public class NAVCASLTermsUpdate : Codable
{
    public var agree:String?
    public var date:Date?

    required public init(){}
}

public class LeadUpgradeResponse : Codable
{
    public var responseStatus:ResponseStatus?

    required public init(){}
}


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