Cdn API

<back to all web services

SubscriptionRequest

Cdn.Api

SubscriptionRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodylongNo
RecentlyExpiredbodyboolNo
CurrentSubscriptionsbodyboolNo
SkipbodyintNo
TakebodyintNo
TitlebodystringNo
SubtitlebodystringNo
IssuesRemainingbodyint?No
TotalIssuesbodyint?No
FirstIssueDatebodyDateTimeNo
StartDatebodyDateTimeNo
ExpirationDatebodyDateTimeNo
ShipMethodbodystringNo
ActiveDaysRemainingbodyintNo
ListPricebodydecimalNo
PricebodydecimalNo
FirstClassPricebodydecimalNo
IsFirstClassbodyboolNo
SpecialPricebodydecimal?No
SpecialPriceExpirationbodyDateTime?No
IsOnlinebodyboolNo
IsPrintbodyboolNo
IsRecurringbodyboolNo
NumberOfSeatsbodyint?No
NextBillingDatebodyDateTimeNo
LastChargeDatebodyDateTimeNo
LastChargeSuccessbodybool?No
DoNotMailbodyboolNo
IssueNowbodyboolNo
IsAutorenewbodyboolNo
IsSuspendedbodybool?No
SuspendStartbodyDateTime?No
SuspendEndbodyDateTime?No
IsCancelledbodybool?No
EmailAddressbodystringNo
PhoneNumberbodystringNo
OrderItem_IdbodylongNo
ParentProductCategory_IdbodylongNo
Product_IdbodylongNo
ProductCategory_IdbodylongNo
ActivebodyboolNo
UpdateTypebodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
SubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<SubscriptionDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
SubscriptionDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
SubtitleformstringNo
IssuesRemainingformintNo
TotalIssuesformintNo
FirstIssueDateformDateTimeNo
StartDateformDateTimeNo
StartDateDisplayformstringNo
ExpirationDateformDateTimeNo
ExpirationDateDisplayformstringNo
ShipMethodformstringNo
ActiveDaysRemainingformintNo
ListPriceformdecimalNo
PriceformdecimalNo
FirstClassPriceformdecimalNo
IsFirstClassformboolNo
SpecialPriceformdecimalNo
SpecialPriceExpirationformDateTime?No
IsOnlineformboolNo
IsPrintformboolNo
IsRecurringformboolNo
NumberOfSeatsformintNo
NextBillingDateformDateTimeNo
LastChargeDateformDateTimeNo
LastChargeSuccessformboolNo
IssueNowformboolNo
DoNotMailformboolNo
IsAutorenewformboolNo
IsSuspendedformboolNo
SuspendStartformDateTime?No
SuspendEndformDateTime?No
IsCancelledformboolNo
EmailAddressformstringNo
PhoneNumberformstringNo
Customer_IdformlongNo
ParentProductCategory_IdformlongNo
ProductCategory_IdformlongNo
Product_IdformlongNo
DateCreatedformDateTimeNo
LastRenewalDateformDateTime?No
LastRenewalDateDisplayformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
SubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<SubscriptionDto>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap11 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: SubscriptionRequest

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<SubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Id>0</Id>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderBy>
  <OrderDirections>
    <SortOrders>Asc</SortOrders>
  </OrderDirections>
  <Active>false</Active>
  <ActiveDaysRemaining>0</ActiveDaysRemaining>
  <CurrentSubscriptions>false</CurrentSubscriptions>
  <CustomerId>0</CustomerId>
  <DoNotMail>false</DoNotMail>
  <EmailAddress>String</EmailAddress>
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <FirstClassPrice>0</FirstClassPrice>
  <FirstIssueDate>0001-01-01T00:00:00</FirstIssueDate>
  <IsAutorenew>false</IsAutorenew>
  <IsCancelled>false</IsCancelled>
  <IsFirstClass>false</IsFirstClass>
  <IsOnline>false</IsOnline>
  <IsPrint>false</IsPrint>
  <IsRecurring>false</IsRecurring>
  <IsSuspended>false</IsSuspended>
  <IssueNow>false</IssueNow>
  <IssuesRemaining>0</IssuesRemaining>
  <LastChargeDate>0001-01-01T00:00:00</LastChargeDate>
  <LastChargeSuccess>false</LastChargeSuccess>
  <ListPrice>0</ListPrice>
  <NextBillingDate>0001-01-01T00:00:00</NextBillingDate>
  <NumberOfSeats>0</NumberOfSeats>
  <OrderItem_Id>0</OrderItem_Id>
  <ParentProductCategory_Id>0</ParentProductCategory_Id>
  <PhoneNumber>String</PhoneNumber>
  <Price>0</Price>
  <ProductCategory_Id>0</ProductCategory_Id>
  <Product_Id>0</Product_Id>
  <RecentlyExpired>false</RecentlyExpired>
  <ShipMethod>String</ShipMethod>
  <Skip>0</Skip>
  <SpecialPrice>0</SpecialPrice>
  <SpecialPriceExpiration>0001-01-01T00:00:00</SpecialPriceExpiration>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Subtitle>String</Subtitle>
  <SuspendEnd>0001-01-01T00:00:00</SuspendEnd>
  <SuspendStart>0001-01-01T00:00:00</SuspendStart>
  <Take>0</Take>
  <Title>String</Title>
  <TotalIssues>0</TotalIssues>
  <UpdateType>String</UpdateType>
</SubscriptionRequest>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<SubscriptionResponse 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:SubscriptionDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:_x003C_ActiveDaysRemaining_x003E_k__BackingField>0</d2p1:_x003C_ActiveDaysRemaining_x003E_k__BackingField>
      <d2p1:_x003C_Customer_Id_x003E_k__BackingField>0</d2p1:_x003C_Customer_Id_x003E_k__BackingField>
      <d2p1:_x003C_DateCreated_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateCreated_x003E_k__BackingField>
      <d2p1:_x003C_DoNotMail_x003E_k__BackingField>false</d2p1:_x003C_DoNotMail_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_FirstClassPrice_x003E_k__BackingField>0</d2p1:_x003C_FirstClassPrice_x003E_k__BackingField>
      <d2p1:_x003C_FirstIssueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_FirstIssueDate_x003E_k__BackingField>
      <d2p1:_x003C_IsAutorenew_x003E_k__BackingField>false</d2p1:_x003C_IsAutorenew_x003E_k__BackingField>
      <d2p1:_x003C_IsCancelled_x003E_k__BackingField>false</d2p1:_x003C_IsCancelled_x003E_k__BackingField>
      <d2p1:_x003C_IsFirstClass_x003E_k__BackingField>false</d2p1:_x003C_IsFirstClass_x003E_k__BackingField>
      <d2p1:_x003C_IsOnline_x003E_k__BackingField>false</d2p1:_x003C_IsOnline_x003E_k__BackingField>
      <d2p1:_x003C_IsPrint_x003E_k__BackingField>false</d2p1:_x003C_IsPrint_x003E_k__BackingField>
      <d2p1:_x003C_IsRecurring_x003E_k__BackingField>false</d2p1:_x003C_IsRecurring_x003E_k__BackingField>
      <d2p1:_x003C_IsSuspended_x003E_k__BackingField>false</d2p1:_x003C_IsSuspended_x003E_k__BackingField>
      <d2p1:_x003C_IssueNow_x003E_k__BackingField>false</d2p1:_x003C_IssueNow_x003E_k__BackingField>
      <d2p1:_x003C_IssuesRemaining_x003E_k__BackingField>0</d2p1:_x003C_IssuesRemaining_x003E_k__BackingField>
      <d2p1:_x003C_LastChargeDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastChargeDate_x003E_k__BackingField>
      <d2p1:_x003C_LastChargeSuccess_x003E_k__BackingField>false</d2p1:_x003C_LastChargeSuccess_x003E_k__BackingField>
      <d2p1:_x003C_LastRenewalDateDisplay_x003E_k__BackingField>String</d2p1:_x003C_LastRenewalDateDisplay_x003E_k__BackingField>
      <d2p1:_x003C_LastRenewalDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastRenewalDate_x003E_k__BackingField>
      <d2p1:_x003C_ListPrice_x003E_k__BackingField>0</d2p1:_x003C_ListPrice_x003E_k__BackingField>
      <d2p1:_x003C_NextBillingDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_NextBillingDate_x003E_k__BackingField>
      <d2p1:_x003C_NumberOfSeats_x003E_k__BackingField>0</d2p1:_x003C_NumberOfSeats_x003E_k__BackingField>
      <d2p1:_x003C_ParentProductCategory_Id_x003E_k__BackingField>0</d2p1:_x003C_ParentProductCategory_Id_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_ProductCategory_Id_x003E_k__BackingField>0</d2p1:_x003C_ProductCategory_Id_x003E_k__BackingField>
      <d2p1:_x003C_Product_Id_x003E_k__BackingField>0</d2p1:_x003C_Product_Id_x003E_k__BackingField>
      <d2p1:_x003C_ShipMethod_x003E_k__BackingField>String</d2p1:_x003C_ShipMethod_x003E_k__BackingField>
      <d2p1:_x003C_SpecialPriceExpiration_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_SpecialPriceExpiration_x003E_k__BackingField>
      <d2p1:_x003C_SpecialPrice_x003E_k__BackingField>0</d2p1:_x003C_SpecialPrice_x003E_k__BackingField>
      <d2p1:_x003C_StartDateDisplay_x003E_k__BackingField>String</d2p1:_x003C_StartDateDisplay_x003E_k__BackingField>
      <d2p1:_x003C_StartDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_StartDate_x003E_k__BackingField>
      <d2p1:_x003C_Subtitle_x003E_k__BackingField>String</d2p1:_x003C_Subtitle_x003E_k__BackingField>
      <d2p1:_x003C_SuspendEnd_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_SuspendEnd_x003E_k__BackingField>
      <d2p1:_x003C_SuspendStart_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_SuspendStart_x003E_k__BackingField>
      <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
      <d2p1:_x003C_TotalIssues_x003E_k__BackingField>0</d2p1:_x003C_TotalIssues_x003E_k__BackingField>
    </d2p1:SubscriptionDto>
  </Data>
</SubscriptionResponse>

    </soap:Body>
</soap:Envelope>