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 .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>