Cdn API - CPG Source

CustomerApiUsageRequest

Cdn.Api

The following routes are available for this service:
GET	/CustomerApiUsageRequest

**CustomerApiUsageRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	query	long	No
MonthsBack	query	int	No

**BaseRequest<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
OrderBy	form	string[]	No
OrderDirections	form	SortOrders[]	No

**CustomerApiUsageResponse** Parameters:
Name	Parameter	Data Type	Required
CurrentMonthBasicCalls	form	int	No
CurrentMonthAdvancedCalls	form	int	No
CurrentMonthCalls	form	int	No
CurrentMonthBasicCost	form	decimal	No
CurrentMonthAdvancedCost	form	decimal	No
CurrentMonthCost	form	decimal	No
ProjectedMonthEndCost	form	decimal	No
MonthlyHistory	form	List<MonthlyApiUsage>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**MonthlyApiUsage** Parameters:
Name	Parameter	Data Type	Required
MonthYear	form	string	No
BasicCalls	form	int	No
AdvancedCalls	form	int	No
TotalCalls	form	int	No
BasicCost	form	decimal	No
AdvancedCost	form	decimal	No
Cost	form	decimal	No

**CustomerApiUsageResponse** Parameters:
Name	Parameter	Data Type	Required
CurrentMonthBasicCalls	form	int	No
CurrentMonthAdvancedCalls	form	int	No
CurrentMonthCalls	form	int	No
CurrentMonthBasicCost	form	decimal	No
CurrentMonthAdvancedCost	form	decimal	No
CurrentMonthCost	form	decimal	No
ProjectedMonthEndCost	form	decimal	No
MonthlyHistory	form	List<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>
  <CurrentMonthAdvancedCalls>0</CurrentMonthAdvancedCalls>
  <CurrentMonthAdvancedCost>0</CurrentMonthAdvancedCost>
  <CurrentMonthBasicCalls>0</CurrentMonthBasicCalls>
  <CurrentMonthBasicCost>0</CurrentMonthBasicCost>
  <MonthlyHistory>
    <MonthlyApiUsage>
      <AdvancedCalls>0</AdvancedCalls>
      <AdvancedCost>0</AdvancedCost>
      <BasicCalls>0</BasicCalls>
      <BasicCost>0</BasicCost>
      <MonthYear>String</MonthYear>
    </MonthlyApiUsage>
  </MonthlyHistory>
  <ProjectedMonthEndCost>0</ProjectedMonthEndCost>
</CustomerApiUsageResponse>