NAV

<back to all web services

LeadUpgrade

The following routes are available for this service:
POST/upgrade-lead
import 'package:servicestack/servicestack.dart';

class LeadUpgradeResponse implements IConvertible
{
    ResponseStatus? responseStatus;

    LeadUpgradeResponse({this.responseStatus});
    LeadUpgradeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "LeadUpgradeResponse";
    TypeContext? context = _ctx;
}

class NAVPhoneUpdate implements IConvertible
{
    String? number;
    String? extension;
    String? codeIdPhoneType;
    String? countryCode;

    NAVPhoneUpdate({this.number,this.extension,this.codeIdPhoneType,this.countryCode});
    NAVPhoneUpdate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        number = json['number'];
        extension = json['extension'];
        codeIdPhoneType = json['codeIdPhoneType'];
        countryCode = json['countryCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'number': number,
        'extension': extension,
        'codeIdPhoneType': codeIdPhoneType,
        'countryCode': countryCode
    };

    getTypeName() => "NAVPhoneUpdate";
    TypeContext? context = _ctx;
}

class NAVAddressUpdate implements IConvertible
{
    String? firstName;
    String? lastName;
    String? addressLine1;
    String? addressLine2;
    String? addressLine3;
    String? addressLine4;
    String? addressLine5;
    String? city;
    String? stateCode;
    String? postalCode;
    String? countryCode;

    NAVAddressUpdate({this.firstName,this.lastName,this.addressLine1,this.addressLine2,this.addressLine3,this.addressLine4,this.addressLine5,this.city,this.stateCode,this.postalCode,this.countryCode});
    NAVAddressUpdate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        firstName = json['firstName'];
        lastName = json['lastName'];
        addressLine1 = json['addressLine1'];
        addressLine2 = json['addressLine2'];
        addressLine3 = json['addressLine3'];
        addressLine4 = json['addressLine4'];
        addressLine5 = json['addressLine5'];
        city = json['city'];
        stateCode = json['stateCode'];
        postalCode = json['postalCode'];
        countryCode = json['countryCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'firstName': firstName,
        'lastName': lastName,
        'addressLine1': addressLine1,
        'addressLine2': addressLine2,
        'addressLine3': addressLine3,
        'addressLine4': addressLine4,
        'addressLine5': addressLine5,
        'city': city,
        'stateCode': stateCode,
        'postalCode': postalCode,
        'countryCode': countryCode
    };

    getTypeName() => "NAVAddressUpdate";
    TypeContext? context = _ctx;
}

class NAVTermsUpdate implements IConvertible
{
    String? version;
    DateTime? date;

    NAVTermsUpdate({this.version,this.date});
    NAVTermsUpdate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        version = json['version'];
        date = JsonConverters.fromJson(json['date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'version': version,
        'date': JsonConverters.toJson(date,'DateTime',context!)
    };

    getTypeName() => "NAVTermsUpdate";
    TypeContext? context = _ctx;
}

class NAVCASLTermsUpdate implements IConvertible
{
    String? agree;
    DateTime? date;

    NAVCASLTermsUpdate({this.agree,this.date});
    NAVCASLTermsUpdate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        agree = json['agree'];
        date = JsonConverters.fromJson(json['date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'agree': agree,
        'date': JsonConverters.toJson(date,'DateTime',context!)
    };

    getTypeName() => "NAVCASLTermsUpdate";
    TypeContext? context = _ctx;
}

class LeadUpgrade implements IPost, IConvertible
{
    double? beeNumber;
    String? emailAddress;
    double? mentorBeeNumber;
    String? language;
    DateTime? birthDate;
    NAVPhoneUpdate? primaryPhone;
    NAVPhoneUpdate? additionalPhone;
    NAVAddressUpdate? billingAddress;
    NAVAddressUpdate? shippingAddress;
    String? governmentId;
    NAVTermsUpdate? termsAgreement;
    NAVTermsUpdate? electronicAgreement;
    String? agentId;
    String? kitNumber;
    double? kitPrice;
    String? paymentMethod;
    double? taxAmount;
    double? donationAmount;
    String? publicityTag;
    String? eStoreUrl;
    String? apptYYYYCC;
    String? apptHHMMSS;
    String? apptYYYYMMDD;
    NAVTermsUpdate? privacyPolicyAgreement;
    NAVTermsUpdate? websiteTermsOfUseAgreement;
    NAVTermsUpdate? ageVerificationAgreement;
    NAVCASLTermsUpdate? caslStatementAgreement;

    LeadUpgrade({this.beeNumber,this.emailAddress,this.mentorBeeNumber,this.language,this.birthDate,this.primaryPhone,this.additionalPhone,this.billingAddress,this.shippingAddress,this.governmentId,this.termsAgreement,this.electronicAgreement,this.agentId,this.kitNumber,this.kitPrice,this.paymentMethod,this.taxAmount,this.donationAmount,this.publicityTag,this.eStoreUrl,this.apptYYYYCC,this.apptHHMMSS,this.apptYYYYMMDD,this.privacyPolicyAgreement,this.websiteTermsOfUseAgreement,this.ageVerificationAgreement,this.caslStatementAgreement});
    LeadUpgrade.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        beeNumber = JsonConverters.toDouble(json['beeNumber']);
        emailAddress = json['emailAddress'];
        mentorBeeNumber = JsonConverters.toDouble(json['mentorBeeNumber']);
        language = json['language'];
        birthDate = JsonConverters.fromJson(json['birthDate'],'DateTime',context!);
        primaryPhone = JsonConverters.fromJson(json['primaryPhone'],'NAVPhoneUpdate',context!);
        additionalPhone = JsonConverters.fromJson(json['additionalPhone'],'NAVPhoneUpdate',context!);
        billingAddress = JsonConverters.fromJson(json['billingAddress'],'NAVAddressUpdate',context!);
        shippingAddress = JsonConverters.fromJson(json['shippingAddress'],'NAVAddressUpdate',context!);
        governmentId = json['governmentId'];
        termsAgreement = JsonConverters.fromJson(json['termsAgreement'],'NAVTermsUpdate',context!);
        electronicAgreement = JsonConverters.fromJson(json['electronicAgreement'],'NAVTermsUpdate',context!);
        agentId = json['agentId'];
        kitNumber = json['kitNumber'];
        kitPrice = JsonConverters.toDouble(json['kitPrice']);
        paymentMethod = json['paymentMethod'];
        taxAmount = JsonConverters.toDouble(json['taxAmount']);
        donationAmount = JsonConverters.toDouble(json['donationAmount']);
        publicityTag = json['publicityTag'];
        eStoreUrl = json['eStoreUrl'];
        apptYYYYCC = json['apptYYYYCC'];
        apptHHMMSS = json['apptHHMMSS'];
        apptYYYYMMDD = json['apptYYYYMMDD'];
        privacyPolicyAgreement = JsonConverters.fromJson(json['privacyPolicyAgreement'],'NAVTermsUpdate',context!);
        websiteTermsOfUseAgreement = JsonConverters.fromJson(json['websiteTermsOfUseAgreement'],'NAVTermsUpdate',context!);
        ageVerificationAgreement = JsonConverters.fromJson(json['ageVerificationAgreement'],'NAVTermsUpdate',context!);
        caslStatementAgreement = JsonConverters.fromJson(json['caslStatementAgreement'],'NAVCASLTermsUpdate',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'beeNumber': beeNumber,
        'emailAddress': emailAddress,
        'mentorBeeNumber': mentorBeeNumber,
        'language': language,
        'birthDate': JsonConverters.toJson(birthDate,'DateTime',context!),
        'primaryPhone': JsonConverters.toJson(primaryPhone,'NAVPhoneUpdate',context!),
        'additionalPhone': JsonConverters.toJson(additionalPhone,'NAVPhoneUpdate',context!),
        'billingAddress': JsonConverters.toJson(billingAddress,'NAVAddressUpdate',context!),
        'shippingAddress': JsonConverters.toJson(shippingAddress,'NAVAddressUpdate',context!),
        'governmentId': governmentId,
        'termsAgreement': JsonConverters.toJson(termsAgreement,'NAVTermsUpdate',context!),
        'electronicAgreement': JsonConverters.toJson(electronicAgreement,'NAVTermsUpdate',context!),
        'agentId': agentId,
        'kitNumber': kitNumber,
        'kitPrice': kitPrice,
        'paymentMethod': paymentMethod,
        'taxAmount': taxAmount,
        'donationAmount': donationAmount,
        'publicityTag': publicityTag,
        'eStoreUrl': eStoreUrl,
        'apptYYYYCC': apptYYYYCC,
        'apptHHMMSS': apptHHMMSS,
        'apptYYYYMMDD': apptYYYYMMDD,
        'privacyPolicyAgreement': JsonConverters.toJson(privacyPolicyAgreement,'NAVTermsUpdate',context!),
        'websiteTermsOfUseAgreement': JsonConverters.toJson(websiteTermsOfUseAgreement,'NAVTermsUpdate',context!),
        'ageVerificationAgreement': JsonConverters.toJson(ageVerificationAgreement,'NAVTermsUpdate',context!),
        'caslStatementAgreement': JsonConverters.toJson(caslStatementAgreement,'NAVCASLTermsUpdate',context!)
    };

    getTypeName() => "LeadUpgrade";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'extensions.avon.ca', types: <String, TypeInfo> {
    'LeadUpgradeResponse': TypeInfo(TypeOf.Class, create:() => LeadUpgradeResponse()),
    'NAVPhoneUpdate': TypeInfo(TypeOf.Class, create:() => NAVPhoneUpdate()),
    'NAVAddressUpdate': TypeInfo(TypeOf.Class, create:() => NAVAddressUpdate()),
    'NAVTermsUpdate': TypeInfo(TypeOf.Class, create:() => NAVTermsUpdate()),
    'NAVCASLTermsUpdate': TypeInfo(TypeOf.Class, create:() => NAVCASLTermsUpdate()),
    'LeadUpgrade': TypeInfo(TypeOf.Class, create:() => LeadUpgrade()),
});

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