NAV

<back to all web services

LeadUpgrade

The following routes are available for this service:
POST/upgrade-lead
namespace NAV.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type LeadUpgradeResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type NAVPhoneUpdate() = 
        member val Number:String = null with get,set
        member val Extension:String = null with get,set
        member val CodeIdPhoneType:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type NAVAddressUpdate() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val AddressLine3:String = null with get,set
        member val AddressLine4:String = null with get,set
        member val AddressLine5:String = null with get,set
        member val City:String = null with get,set
        member val StateCode:String = null with get,set
        member val PostalCode:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type NAVTermsUpdate() = 
        member val Version:String = null with get,set
        member val Date:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type NAVCASLTermsUpdate() = 
        member val Agree:String = null with get,set
        member val Date:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type LeadUpgrade() = 
        interface IPost
        member val BeeNumber:Decimal = new Decimal() with get,set
        member val EmailAddress:String = null with get,set
        member val MentorBeeNumber:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Language:String = null with get,set
        member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PrimaryPhone:NAVPhoneUpdate = null with get,set
        member val AdditionalPhone:NAVPhoneUpdate = null with get,set
        member val BillingAddress:NAVAddressUpdate = null with get,set
        member val ShippingAddress:NAVAddressUpdate = null with get,set
        member val GovernmentId:String = null with get,set
        member val TermsAgreement:NAVTermsUpdate = null with get,set
        member val ElectronicAgreement:NAVTermsUpdate = null with get,set
        member val AgentId:String = null with get,set
        member val KitNumber:String = null with get,set
        member val KitPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PaymentMethod:String = null with get,set
        member val TaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val DonationAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PublicityTag:String = null with get,set
        member val EStoreUrl:String = null with get,set
        member val ApptYYYYCC:String = null with get,set
        member val ApptHHMMSS:String = null with get,set
        member val ApptYYYYMMDD:String = null with get,set
        member val PrivacyPolicyAgreement:NAVTermsUpdate = null with get,set
        member val WebsiteTermsOfUseAgreement:NAVTermsUpdate = null with get,set
        member val AgeVerificationAgreement:NAVTermsUpdate = null with get,set
        member val CASLStatementAgreement:NAVCASLTermsUpdate = null with get,set

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