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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<LeadUpgrade xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <AdditionalPhone>
    <CodeIdPhoneType>String</CodeIdPhoneType>
    <CountryCode>String</CountryCode>
    <Extension>String</Extension>
    <Number>String</Number>
  </AdditionalPhone>
  <AgeVerificationAgreement>
    <Date>0001-01-01T00:00:00</Date>
    <Version>String</Version>
  </AgeVerificationAgreement>
  <AgentId>String</AgentId>
  <ApptHHMMSS>String</ApptHHMMSS>
  <ApptYYYYCC>String</ApptYYYYCC>
  <ApptYYYYMMDD>String</ApptYYYYMMDD>
  <BeeNumber>0</BeeNumber>
  <BillingAddress>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <AddressLine3>String</AddressLine3>
    <AddressLine4>String</AddressLine4>
    <AddressLine5>String</AddressLine5>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <PostalCode>String</PostalCode>
    <StateCode>String</StateCode>
  </BillingAddress>
  <BirthDate>0001-01-01T00:00:00</BirthDate>
  <CASLStatementAgreement>
    <Agree>String</Agree>
    <Date>0001-01-01T00:00:00</Date>
  </CASLStatementAgreement>
  <DonationAmount>0</DonationAmount>
  <EStoreUrl>String</EStoreUrl>
  <ElectronicAgreement>
    <Date>0001-01-01T00:00:00</Date>
    <Version>String</Version>
  </ElectronicAgreement>
  <EmailAddress>String</EmailAddress>
  <GovernmentId>String</GovernmentId>
  <KitNumber>String</KitNumber>
  <KitPrice>0</KitPrice>
  <Language>String</Language>
  <MentorBeeNumber>0</MentorBeeNumber>
  <PaymentMethod>String</PaymentMethod>
  <PrimaryPhone>
    <CodeIdPhoneType>String</CodeIdPhoneType>
    <CountryCode>String</CountryCode>
    <Extension>String</Extension>
    <Number>String</Number>
  </PrimaryPhone>
  <PrivacyPolicyAgreement>
    <Date>0001-01-01T00:00:00</Date>
    <Version>String</Version>
  </PrivacyPolicyAgreement>
  <PublicityTag>String</PublicityTag>
  <ShippingAddress>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <AddressLine3>String</AddressLine3>
    <AddressLine4>String</AddressLine4>
    <AddressLine5>String</AddressLine5>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <PostalCode>String</PostalCode>
    <StateCode>String</StateCode>
  </ShippingAddress>
  <TaxAmount>0</TaxAmount>
  <TermsAgreement>
    <Date>0001-01-01T00:00:00</Date>
    <Version>String</Version>
  </TermsAgreement>
  <WebsiteTermsOfUseAgreement>
    <Date>0001-01-01T00:00:00</Date>
    <Version>String</Version>
  </WebsiteTermsOfUseAgreement>
</LeadUpgrade>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LeadUpgradeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</LeadUpgradeResponse>