| POST | /upgrade-lead |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeeNumber | body | decimal | No | |
| EmailAddress | body | string | No | |
| MentorBeeNumber | body | decimal? | No | |
| Language | body | string | No | |
| BirthDate | body | DateTime? | No | |
| PrimaryPhone | body | NAVPhoneUpdate | No | |
| AdditionalPhone | body | NAVPhoneUpdate | No | |
| BillingAddress | body | NAVAddressUpdate | No | |
| ShippingAddress | body | NAVAddressUpdate | No | |
| GovernmentId | body | string | No | |
| TermsAgreement | body | NAVTermsUpdate | No | |
| ElectronicAgreement | body | NAVTermsUpdate | No | |
| AgentId | body | string | No | |
| KitNumber | body | string | No | |
| KitPrice | body | decimal? | No | |
| PaymentMethod | body | string | No | |
| TaxAmount | body | decimal? | No | |
| DonationAmount | body | decimal? | No | |
| PublicityTag | body | string | No | |
| EStoreUrl | body | string | No | |
| ApptYYYYCC | body | string | No | |
| ApptHHMMSS | body | string | No | |
| ApptYYYYMMDD | body | string | No | |
| PrivacyPolicyAgreement | body | NAVTermsUpdate | No | |
| WebsiteTermsOfUseAgreement | body | NAVTermsUpdate | No | |
| AgeVerificationAgreement | body | NAVTermsUpdate | No | |
| CASLStatementAgreement | body | NAVCASLTermsUpdate | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | string | No | |
| Extension | form | string | No | |
| CodeIdPhoneType | form | string | No | |
| CountryCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| AddressLine4 | form | string | No | |
| AddressLine5 | form | string | No | |
| City | form | string | No | |
| StateCode | form | string | No | |
| PostalCode | form | string | No | |
| CountryCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | string | No | |
| Date | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Agree | form | string | No | |
| Date | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
beeNumber: 0,
emailAddress: String,
mentorBeeNumber: 0,
language: String,
birthDate: 0001-01-01T00:00:00,
primaryPhone:
{
number: String,
extension: String,
codeIdPhoneType: String,
countryCode: String
},
additionalPhone:
{
number: String,
extension: String,
codeIdPhoneType: String,
countryCode: String
},
billingAddress:
{
firstName: String,
lastName: String,
addressLine1: String,
addressLine2: String,
addressLine3: String,
addressLine4: String,
addressLine5: String,
city: String,
stateCode: String,
postalCode: String,
countryCode: String
},
shippingAddress:
{
firstName: String,
lastName: String,
addressLine1: String,
addressLine2: String,
addressLine3: String,
addressLine4: String,
addressLine5: String,
city: String,
stateCode: String,
postalCode: String,
countryCode: String
},
governmentId: String,
termsAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
electronicAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
agentId: String,
kitNumber: String,
kitPrice: 0,
paymentMethod: String,
taxAmount: 0,
donationAmount: 0,
publicityTag: String,
eStoreUrl: String,
apptYYYYCC: String,
apptHHMMSS: String,
apptYYYYMMDD: String,
privacyPolicyAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
websiteTermsOfUseAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
ageVerificationAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
caslStatementAgreement:
{
agree: String,
date: 0001-01-01T00:00:00
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}