NAV

<back to all web services

LeadUpgrade

The following routes are available for this service:
POST/upgrade-lead
import java.math.*
import java.util.*
import net.servicestack.client.*


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

open class NAVPhoneUpdate
{
    var number:String? = null
    var extension:String? = null
    var codeIdPhoneType:String? = null
    var countryCode:String? = null
}

open class NAVAddressUpdate
{
    var firstName:String? = null
    var lastName:String? = null
    var addressLine1:String? = null
    var addressLine2:String? = null
    var addressLine3:String? = null
    var addressLine4:String? = null
    var addressLine5:String? = null
    var city:String? = null
    var stateCode:String? = null
    var postalCode:String? = null
    var countryCode:String? = null
}

open class NAVTermsUpdate
{
    var version:String? = null
    var date:Date? = null
}

open class NAVCASLTermsUpdate
{
    var agree:String? = null
    var date:Date? = null
}

open class LeadUpgradeResponse
{
    var responseStatus:ResponseStatus? = null
}

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