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