Cdn API - CPG Source

<back to all web services

ExpirationsReportRequest

Cdn.Api

The following routes are available for this service:
GET/ExpirationsReportRequest
ExpirationsReportRequest Parameters:
NameParameterData TypeRequiredDescription
FromDatequerystringNo
ToDatequerystringNo
PagequeryintNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
ExpirationsReportResponse Parameters:
NameParameterData TypeRequiredDescription
ExpiredItemsformExpirationsReportItemDto[]No
FromDateformstringNo
ToDateformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
ExpirationsReportItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
OrderDateformDateTimeNo
DisplayNameformstringNo
ProductDisplayNameformstringNo
ExpirationDateformDateTimeNo
PriceformdecimalNo
IssuesRemainingformintNo
CustomerIdformlongNo
CustomerUrlformstringNo
OrderDateDisplayformstringNo
ExpirationDateDisplayformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
ProvinceformstringNo
CountryformstringNo
EmailAddressformstringNo
PhoneNumberformstringNo
ExpirationsReportResponse Parameters:
NameParameterData TypeRequiredDescription
ExpiredItemsformExpirationsReportItemDto[]No
FromDateformstringNo
ToDateformstringNo

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

<ExpirationsReportResponse 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>
  <ExpiredItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:ExpirationsReportItemDto>
      <d2p1:_x003C_Address2_x003E_k__BackingField>String</d2p1:_x003C_Address2_x003E_k__BackingField>
      <d2p1:_x003C_Address_x003E_k__BackingField>String</d2p1:_x003C_Address_x003E_k__BackingField>
      <d2p1:_x003C_City_x003E_k__BackingField>String</d2p1:_x003C_City_x003E_k__BackingField>
      <d2p1:_x003C_Country_x003E_k__BackingField>String</d2p1:_x003C_Country_x003E_k__BackingField>
      <d2p1:_x003C_CustomerId_x003E_k__BackingField>0</d2p1:_x003C_CustomerId_x003E_k__BackingField>
      <d2p1:_x003C_CustomerUrl_x003E_k__BackingField>String</d2p1:_x003C_CustomerUrl_x003E_k__BackingField>
      <d2p1:_x003C_DisplayName_x003E_k__BackingField>String</d2p1:_x003C_DisplayName_x003E_k__BackingField>
      <d2p1:_x003C_EmailAddress_x003E_k__BackingField>String</d2p1:_x003C_EmailAddress_x003E_k__BackingField>
      <d2p1:_x003C_ExpirationDateDisplay_x003E_k__BackingField>String</d2p1:_x003C_ExpirationDateDisplay_x003E_k__BackingField>
      <d2p1:_x003C_ExpirationDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ExpirationDate_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_IssuesRemaining_x003E_k__BackingField>0</d2p1:_x003C_IssuesRemaining_x003E_k__BackingField>
      <d2p1:_x003C_OrderDateDisplay_x003E_k__BackingField>String</d2p1:_x003C_OrderDateDisplay_x003E_k__BackingField>
      <d2p1:_x003C_OrderDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_OrderDate_x003E_k__BackingField>
      <d2p1:_x003C_PhoneNumber_x003E_k__BackingField>String</d2p1:_x003C_PhoneNumber_x003E_k__BackingField>
      <d2p1:_x003C_Price_x003E_k__BackingField>0</d2p1:_x003C_Price_x003E_k__BackingField>
      <d2p1:_x003C_ProductDisplayName_x003E_k__BackingField>String</d2p1:_x003C_ProductDisplayName_x003E_k__BackingField>
      <d2p1:_x003C_Province_x003E_k__BackingField>String</d2p1:_x003C_Province_x003E_k__BackingField>
      <d2p1:_x003C_State_x003E_k__BackingField>String</d2p1:_x003C_State_x003E_k__BackingField>
      <d2p1:_x003C_Zip_x003E_k__BackingField>String</d2p1:_x003C_Zip_x003E_k__BackingField>
    </d2p1:ExpirationsReportItemDto>
  </ExpiredItems>
  <FromDate>String</FromDate>
  <ToDate>String</ToDate>
</ExpirationsReportResponse>