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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerApiUsageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <CurrentMonthCalls>0</CurrentMonthCalls>
  <CurrentMonthCost>0</CurrentMonthCost>
  <MonthlyHistory>
    <MonthlyApiUsage>
      <Cost>0</Cost>
      <MonthYear>String</MonthYear>
      <TotalCalls>0</TotalCalls>
    </MonthlyApiUsage>
  </MonthlyHistory>
  <ProjectedMonthEndCost>0</ProjectedMonthEndCost>
</CustomerApiUsageResponse>