NAV

<back to all web services

ProfileUpdate

The following routes are available for this service:
PUT/profile/{BeeNumber}

export class ProfileUpdateResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<ProfileUpdateResponse>) { (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 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 NAVBankAccountUpdate
{
    public accountName?: string;
    public bankName?: string;
    public accountNumber?: string;
    public routingNumber?: string;

    public constructor(init?: Partial<NAVBankAccountUpdate>) { (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 ProfileUpdate implements IPut
{
    public beeNumber?: number;
    public firstName?: string;
    public lastName?: string;
    public nickname?: string;
    public birthDate?: string;
    public billingAddress?: NAVAddressUpdate;
    public shippingAddress?: NAVAddressUpdate;
    public governmentId?: string;
    public emailAddress?: string;
    public primaryPhone?: NAVPhoneUpdate;
    public additionalPhone?: NAVPhoneUpdate;
    public onlineStoreAddress?: string;
    public language?: string;
    public publicityPermission?: string;
    public findMeOnline?: boolean;
    public oldPassword?: string;
    public newPassword?: string;
    public passwordHint?: string;
    public bankAccount?: NAVBankAccountUpdate;
    public termsAgreement?: NAVTermsUpdate;
    public electronicAgreement?: NAVTermsUpdate;
    public agentId?: string;
    public taxExemptCode?: string;
    public customerType?: string;
    public customerTypeEffectiveDate?: string;
    public repAttachmentNumber?: number;
    public repRelationship?: string;
    public preferredDeliveryMethod?: string;
    public noCode21?: string;
    public noCode30?: string;
    public privacyPolicyAgreement?: NAVTermsUpdate;
    public websiteTermsOfUseAgreement?: NAVTermsUpdate;
    public ageVerificationAgreement?: NAVTermsUpdate;
    public caslStatementAgreement?: NAVCASLTermsUpdate;

    public constructor(init?: Partial<ProfileUpdate>) { (Object as any).assign(this, init); }
}

TypeScript ProfileUpdate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /profile/{BeeNumber} HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"beeNumber":0,"firstName":"String","lastName":"String","nickname":"String","birthDate":"0001-01-01T00:00:00.0000000","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","emailAddress":"String","primaryPhone":{"number":"String","extension":"String","codeIdPhoneType":"String","countryCode":"String"},"additionalPhone":{"number":"String","extension":"String","codeIdPhoneType":"String","countryCode":"String"},"onlineStoreAddress":"String","language":"String","publicityPermission":"String","findMeOnline":false,"oldPassword":"String","newPassword":"String","passwordHint":"String","bankAccount":{"accountName":"String","bankName":"String","accountNumber":"String","routingNumber":"String"},"termsAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"electronicAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"agentId":"String","taxExemptCode":"String","customerType":"String","customerTypeEffectiveDate":"0001-01-01T00:00:00.0000000","repAttachmentNumber":0,"repRelationship":"String","preferredDeliveryMethod":"String","noCode21":"String","noCode30":"String","privacyPolicyAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"websiteTermsOfUseAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"ageVerificationAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"caslStatementAgreement":{"agree":"String","date":"0001-01-01T00:00:00.0000000"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}