Cdn API

<back to all web services

CustomerSubscriptionStatusRequest

Cdn.Api

The following routes are available for this service:
GET/CustomerSubscriptionStatusRequest
CustomerSubscriptionStatusRequest Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
CustomerSubscriptionStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformSubscriptionStatusDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
SubscriptionStatusDto Parameters:
NameParameterData TypeRequiredDescription
SubscriptionStatusesformList<SubscriptionStatus>No
AllowedCatalogsRetailformstringNo
AllowedCatalogsWholesaleformstringNo
AllowRetailformboolNo
AllowWholesaleformboolNo
SubscribedProductCategoriesformList<long>No
SubscriptionStatus Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ProductCategoryIdformlongNo
ProductCateoryNameformstringNo
ProductCateorySubtitleformstringNo
ProductIdformlongNo
ProductNameformstringNo
ProductSubtitleformstringNo
IsSingleIssueformboolNo
IsOnlineformboolNo
IsPrintformboolNo
IsRecurringformboolNo
IssuesRemainingformintNo
TotalIssuesformintNo
SubscriptionStartDateformDateTimeNo
SubscriptionStartDateDisplayformstringNo
ExpirationDateformDateTimeNo
ExpirationDateDisplayformstringNo
NextBillingDateformDateTimeNo
NextBillingDateDisplayformstringNo
ShipMethodformstringNo
ActiveDaysRemainingformintNo

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

<CustomerSubscriptionStatusResponse 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>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:AllowRetail>false</d2p1:AllowRetail>
    <d2p1:AllowWholesale>false</d2p1:AllowWholesale>
    <d2p1:AllowedCatalogsRetail>String</d2p1:AllowedCatalogsRetail>
    <d2p1:AllowedCatalogsWholesale>String</d2p1:AllowedCatalogsWholesale>
    <d2p1:SubscribedProductCategories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>0</d3p1:long>
    </d2p1:SubscribedProductCategories>
    <d2p1:SubscriptionStatuses xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Misc">
      <d3p1:SubscriptionStatus>
        <d3p1:ActiveDaysRemaining>0</d3p1:ActiveDaysRemaining>
        <d3p1:ExpirationDate>0001-01-01T00:00:00</d3p1:ExpirationDate>
        <d3p1:ExpirationDateDisplay>String</d3p1:ExpirationDateDisplay>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:IsOnline>false</d3p1:IsOnline>
        <d3p1:IsPrint>false</d3p1:IsPrint>
        <d3p1:IsRecurring>false</d3p1:IsRecurring>
        <d3p1:IsSingleIssue>false</d3p1:IsSingleIssue>
        <d3p1:IssuesRemaining>0</d3p1:IssuesRemaining>
        <d3p1:NextBillingDate>0001-01-01T00:00:00</d3p1:NextBillingDate>
        <d3p1:NextBillingDateDisplay>String</d3p1:NextBillingDateDisplay>
        <d3p1:ProductCategoryId>0</d3p1:ProductCategoryId>
        <d3p1:ProductCateoryName>String</d3p1:ProductCateoryName>
        <d3p1:ProductCateorySubtitle>String</d3p1:ProductCateorySubtitle>
        <d3p1:ProductId>0</d3p1:ProductId>
        <d3p1:ProductName>String</d3p1:ProductName>
        <d3p1:ProductSubtitle>String</d3p1:ProductSubtitle>
        <d3p1:ShipMethod>String</d3p1:ShipMethod>
        <d3p1:SubscriptionStartDate>0001-01-01T00:00:00</d3p1:SubscriptionStartDate>
        <d3p1:SubscriptionStartDateDisplay>String</d3p1:SubscriptionStartDateDisplay>
        <d3p1:TotalIssues>0</d3p1:TotalIssues>
      </d3p1:SubscriptionStatus>
    </d2p1:SubscriptionStatuses>
  </Data>
</CustomerSubscriptionStatusResponse>