NAV

<back to all web services

SummaryReportRepresentativeRegionBGet

Region B is middle section of summary report that shows cycles for this year compared to last year

The following routes are available for this service:
GET/summary-report/{BeeNumber}/region-b

export class BeeNumberDisplaySet
{
    public beeNumber?: number;
    public externalIds?: string[];
    public salesOrganizationId?: string;

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

export class SummaryValues
{
    public c1?: number;
    public c2?: number;
    public c3?: number;
    public c4?: number;
    public c5?: number;
    public c6?: number;
    public c7?: number;
    public c8?: number;
    public c9?: number;
    public c10?: number;
    public c11?: number;
    public c12?: number;
    public c13?: number;
    public c14?: number;
    public c15?: number;
    public c16?: number;
    public c17?: number;
    public c18?: number;
    public c19?: number;
    public c20?: number;
    public c21?: number;
    public c22?: number;
    public c23?: number;
    public c24?: number;
    public c25?: number;
    public c26?: number;
    public c27?: number;
    public c28?: number;
    public ytd?: number;
    public q1?: number;
    public q2?: number;
    public q3?: number;
    public q4?: number;
    public q5?: number;
    public qtd?: number;
    public currentQuarter?: number;
    public currentVSPCPercent?: number;
    public currentVSPYPercent?: number;

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

export class YearlyValues
{
    public currentYear?: SummaryValues;
    public priorYear?: SummaryValues;
    public percentVsPriorYear?: SummaryValues;

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

export class RepresentativeSummaryReportRegionBViewModel
{
    public beeNumber?: BeeNumberDisplaySet;
    public currentYear?: number;
    public priorYear?: number;
    public awardSales?: YearlyValues;
    public netSales?: YearlyValues;
    public numberOfCustomers?: YearlyValues;
    public orders?: YearlyValues;
    public activity?: YearlyValues;
    public aosAwardSales?: YearlyValues;
    public repCount?: YearlyValues;
    public aosNetSales?: YearlyValues;

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

export class SummaryReportRepresentativeRegionBGetResponse extends GetResponse<RepresentativeSummaryReportRegionBViewModel>
{

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

/**
* Region B is middle section of summary report that shows cycles for this year compared to last year
*/
export class SummaryReportRepresentativeRegionBGet implements IGet
{
    public beeNumber?: number;

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

export class GetResponse<TEntity>
{
    public item?: TEntity;
    public responseStatus?: ResponseStatus;

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

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

GET /summary-report/{BeeNumber}/region-b HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/csv

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

{"item":{"beeNumber":{"beeNumber":0,"externalIds":["String"],"salesOrganizationId":"String"},"currentYear":0,"priorYear":0,"awardSales":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"netSales":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"numberOfCustomers":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"orders":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"activity":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"aosAwardSales":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"repCount":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}},"aosNetSales":{"currentYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"priorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0},"percentVsPriorYear":{"c1":0,"c2":0,"c3":0,"c4":0,"c5":0,"c6":0,"c7":0,"c8":0,"c9":0,"c10":0,"c11":0,"c12":0,"c13":0,"c14":0,"c15":0,"c16":0,"c17":0,"c18":0,"c19":0,"c20":0,"c21":0,"c22":0,"c23":0,"c24":0,"c25":0,"c26":0,"c27":0,"c28":0,"ytd":0,"q1":0,"q2":0,"q3":0,"q4":0,"q5":0,"qtd":0,"currentQuarter":0,"currentVSPCPercent":0,"currentVSPYPercent":0}}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}