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
import Foundation
import ServiceStack

/**
* Region B is middle section of summary report that shows cycles for this year compared to last year
*/
public class SummaryReportRepresentativeRegionBGet : IGet, Codable
{
    public var beeNumber:Double?

    required public init(){}
}

public class SummaryReportRepresentativeRegionBGetResponse : GetResponse<RepresentativeSummaryReportRegionBViewModel>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class GetResponse<TEntity : Codable> : Codable
{
    public var item:TEntity?
    public var responseStatus:ResponseStatus?

    required public init(){}
}

public class RepresentativeSummaryReportRegionBViewModel : Codable
{
    public var beeNumber:BeeNumberDisplaySet?
    public var currentYear:Int?
    public var priorYear:Int?
    public var awardSales:YearlyValues?
    public var netSales:YearlyValues?
    public var numberOfCustomers:YearlyValues?
    public var orders:YearlyValues?
    public var activity:YearlyValues?
    public var aosAwardSales:YearlyValues?
    public var repCount:YearlyValues?
    public var aosNetSales:YearlyValues?

    required public init(){}
}

public class BeeNumberDisplaySet : Codable
{
    public var beeNumber:Double?
    public var externalIds:[String] = []
    public var salesOrganizationId:String?

    required public init(){}
}

public class YearlyValues : Codable
{
    public var currentYear:SummaryValues?
    public var priorYear:SummaryValues?
    public var percentVsPriorYear:SummaryValues?

    required public init(){}
}

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

    required public init(){}
}


Swift SummaryReportRepresentativeRegionBGet DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}