| GET | /call-center/profile/{BeeNumber} | ||
|---|---|---|---|
| GET | /call-center/profiles/{BeeNumber} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeeNumber | path | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| FullName | form | string | No | |
| FirstName | form | string | No | |
| MiddleName | form | string | No | |
| LastName | form | string | No | |
| BeeNumber | form | decimal? | No | |
| AccountStatus | form | string | No | |
| CollectionTag | form | string | No | |
| ReinstatedTag | form | string | No | |
| ReinstatedDate | form | string | No | |
| PrimaryPhone | form | string | No | |
| SecondaryPhone | form | string | No | |
| Loa | form | decimal? | No | |
| AccountType | form | string | No | |
| AmountDue | form | decimal? | No | |
| Birthday | form | DateTime? | No | |
| Language | form | string | No | |
| MailingAddress | form | CallCenterAddress | No | |
| ShippingAddress | form | CallCenterAddress | No | |
| ApptDate | form | DateTime? | No | |
| AppointmentCampYear | form | string | No | |
| UplineAccount | form | decimal? | No | |
| UplineName | form | string | No | |
| AwardSalesCurrentCamp | form | decimal? | No | |
| AwardSalesPriorCamp | form | decimal? | No | |
| AwardSalesCurrentCycle | form | decimal? | No | |
| AwardSalesPriorCycle | form | decimal? | No | |
| AwardSalesCurrentBonus | form | decimal? | No | |
| AwardSalesPriorBonus | form | decimal? | No | |
| AwardSalesPreviousCamp | form | decimal? | No | |
| BonusSalesPreviousCamp | form | decimal? | No | |
| LastPaymentDate | form | DateTime? | No | |
| LastPaymentAmount | form | decimal? | No | |
| TotalPastDue | form | decimal? | No | |
| PastDue | form | decimal? | No | |
| PastDue2 | form | decimal? | No | |
| PastDue3 | form | decimal? | No | |
| CurrentBalance | form | decimal? | No | |
| AwardSalesTier | form | string | No | |
| NoCodeBilledNotShipped | form | string | No | |
| CreditCardPaymentAllowed | form | string | No | |
| TermsVersion | form | string | No | |
| TermsAcknowledgeDate | form | DateTime? | No | |
| CoApplicantName | form | string | No | |
| CoApplicantSsn | form | string | No | |
| CoApplicantBirthday | form | DateTime? | No | |
| CoApplicantRelation | form | string | No | |
| UpdatedForCampaign | form | string | No | |
| CreditLimit | form | decimal? | No | |
| DirectDepositPaymentsTag | form | bool? | No | |
| LeadershipTag | form | string | No | |
| LeadershipLevel | form | string | No | |
| PCTag | form | string | No | |
| PCPremierTag | form | string | No | |
| DeceasedTag | form | string | No | |
| EmailAddress | form | string | No | |
| Nickname | form | string | No | |
| WebPageUrl | form | string | No | |
| LegalDateOfEnrollment | form | DateTime? | No | |
| DeliveryMethod | form | string | No | |
| SocialSecurityNumber | form | string | No | |
| IsNewLeadershipLevel | form | string | No | |
| IsNewRecognitionLevel | form | string | No | |
| DisabilityTag | form | string | No | |
| RetireeTag | form | bool? | No | |
| LABCTag | form | string | No | |
| RemovalReason | form | string | No | |
| RepAccountNumber | form | decimal? | No | |
| RepAccountName | form | string | No | |
| NoCode21 | form | string | No | |
| TaxExempt | form | string | No | |
| PendingOrdersBalance | form | decimal | No | |
| NumberPSA | form | decimal? | No | |
| IsNonPerformingLeader | form | string | No | |
| MetPSAReq | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| City | form | string | No | |
| StateCode | form | string | No | |
| PostalCode | form | string | No | |
| CountryCode | form | string | 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.
GET /call-center/profile/{BeeNumber} HTTP/1.1
Host: extensions.avon.ca
Accept: text/jsv
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
}
},
fullName: String,
firstName: String,
middleName: String,
lastName: String,
beeNumber: 0,
accountStatus: String,
collectionTag: String,
reinstatedTag: String,
reinstatedDate: String,
primaryPhone: String,
secondaryPhone: String,
loa: 0,
accountType: String,
amountDue: 0,
birthday: 0001-01-01T00:00:00,
language: String,
mailingAddress:
{
addressLine1: String,
addressLine2: String,
addressLine3: String,
city: String,
stateCode: String,
postalCode: String,
countryCode: String
},
shippingAddress:
{
addressLine1: String,
addressLine2: String,
addressLine3: String,
city: String,
stateCode: String,
postalCode: String,
countryCode: String
},
apptDate: 0001-01-01T00:00:00,
appointmentCampYear: String,
uplineAccount: 0,
uplineName: String,
awardSalesCurrentCamp: 0,
awardSalesPriorCamp: 0,
awardSalesCurrentCycle: 0,
awardSalesPriorCycle: 0,
awardSalesCurrentBonus: 0,
awardSalesPriorBonus: 0,
awardSalesPreviousCamp: 0,
bonusSalesPreviousCamp: 0,
lastPaymentDate: 0001-01-01T00:00:00,
lastPaymentAmount: 0,
totalPastDue: 0,
pastDue: 0,
pastDue2: 0,
pastDue3: 0,
currentBalance: 0,
awardSalesTier: String,
noCodeBilledNotShipped: String,
creditCardPaymentAllowed: String,
termsVersion: String,
termsAcknowledgeDate: 0001-01-01T00:00:00,
coApplicantName: String,
coApplicantSsn: String,
coApplicantBirthday: 0001-01-01T00:00:00,
coApplicantRelation: String,
updatedForCampaign: String,
creditLimit: 0,
directDepositPaymentsTag: False,
leadershipTag: String,
leadershipLevel: String,
pcTag: String,
pcPremierTag: String,
deceasedTag: String,
emailAddress: String,
nickname: String,
webPageUrl: String,
legalDateOfEnrollment: 0001-01-01T00:00:00,
deliveryMethod: String,
socialSecurityNumber: String,
isNewLeadershipLevel: String,
isNewRecognitionLevel: String,
disabilityTag: String,
retireeTag: False,
labcTag: String,
removalReason: String,
repAccountNumber: 0,
repAccountName: String,
noCode21: String,
taxExempt: String,
pendingOrdersBalance: 0,
numberPSA: 0,
isNonPerformingLeader: String,
metPSAReq: String
}