POST | /upgrade-lead |
---|
export class LeadUpgradeResponse
{
public responseStatus?: ResponseStatus;
public constructor(init?: Partial<LeadUpgradeResponse>) { (Object as any).assign(this, init); }
}
export class NAVPhoneUpdate
{
public number?: string;
public extension?: string;
public codeIdPhoneType?: string;
public countryCode?: string;
public constructor(init?: Partial<NAVPhoneUpdate>) { (Object as any).assign(this, init); }
}
export class NAVAddressUpdate
{
public firstName?: string;
public lastName?: string;
public addressLine1?: string;
public addressLine2?: string;
public addressLine3?: string;
public addressLine4?: string;
public addressLine5?: string;
public city?: string;
public stateCode?: string;
public postalCode?: string;
public countryCode?: string;
public constructor(init?: Partial<NAVAddressUpdate>) { (Object as any).assign(this, init); }
}
export class NAVTermsUpdate
{
public version?: string;
public date?: string;
public constructor(init?: Partial<NAVTermsUpdate>) { (Object as any).assign(this, init); }
}
export class NAVCASLTermsUpdate
{
public agree?: string;
public date?: string;
public constructor(init?: Partial<NAVCASLTermsUpdate>) { (Object as any).assign(this, init); }
}
export class LeadUpgrade implements IPost
{
public beeNumber?: number;
public emailAddress?: string;
public mentorBeeNumber?: number;
public language?: string;
public birthDate?: string;
public primaryPhone?: NAVPhoneUpdate;
public additionalPhone?: NAVPhoneUpdate;
public billingAddress?: NAVAddressUpdate;
public shippingAddress?: NAVAddressUpdate;
public governmentId?: string;
public termsAgreement?: NAVTermsUpdate;
public electronicAgreement?: NAVTermsUpdate;
public agentId?: string;
public kitNumber?: string;
public kitPrice?: number;
public paymentMethod?: string;
public taxAmount?: number;
public donationAmount?: number;
public publicityTag?: string;
public eStoreUrl?: string;
public apptYYYYCC?: string;
public apptHHMMSS?: string;
public apptYYYYMMDD?: string;
public privacyPolicyAgreement?: NAVTermsUpdate;
public websiteTermsOfUseAgreement?: NAVTermsUpdate;
public ageVerificationAgreement?: NAVTermsUpdate;
public caslStatementAgreement?: NAVCASLTermsUpdate;
public constructor(init?: Partial<LeadUpgrade>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>