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