Cdn API - CPG Source

<back to all web services

CustomerApiUsageRequest

Cdn.Api

The following routes are available for this service:
GET/CustomerApiUsageRequest
CustomerApiUsageRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdquerylongNo
MonthsBackqueryintNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
CustomerApiUsageResponse Parameters:
NameParameterData TypeRequiredDescription
CurrentMonthCallsformintNo
CurrentMonthCostformdecimalNo
ProjectedMonthEndCostformdecimalNo
MonthlyHistoryformList<MonthlyApiUsage>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
MonthlyApiUsage Parameters:
NameParameterData TypeRequiredDescription
MonthYearformstringNo
TotalCallsformintNo
CostformdecimalNo
CustomerApiUsageResponse Parameters:
NameParameterData TypeRequiredDescription
CurrentMonthCallsformintNo
CurrentMonthCostformdecimalNo
ProjectedMonthEndCostformdecimalNo
MonthlyHistoryformList<MonthlyApiUsage>No

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 /CustomerApiUsageRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CurrentMonthCalls: 0,
	CurrentMonthCost: 0,
	ProjectedMonthEndCost: 0,
	MonthlyHistory: 
	[
		{
			MonthYear: String,
			TotalCalls: 0,
			Cost: 0
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}