Cdn API - CPG Source

SubscriptionRequest

Cdn.Api

**SubscriptionRequest** Parameters:
Name	Parameter	Data Type	Required
CustomerId	body	long	No
RecentlyExpired	body	bool	No
CurrentSubscriptions	body	bool	No
Skip	body	int	No
Take	body	int	No
Title	body	string	No
Subtitle	body	string	No
IssuesRemaining	body	int?	No
TotalIssues	body	int?	No
FirstIssueDate	body	DateTime	No
StartDate	body	DateTime	No
ExpirationDate	body	DateTime	No
ShipMethod	body	string	No
ActiveDaysRemaining	body	int	No
ListPrice	body	decimal	No
Price	body	decimal	No
FirstClassPrice	body	decimal	No
IsFirstClass	body	bool	No
SpecialPrice	body	decimal?	No
SpecialPriceExpiration	body	DateTime?	No
IsOnline	body	bool	No
IsPrint	body	bool	No
IsRecurring	body	bool	No
NumberOfSeats	body	int?	No
NextBillingDate	body	DateTime	No
LastChargeDate	body	DateTime	No
LastChargeSuccess	body	bool?	No
DoNotMail	body	bool	No
IssueNow	body	bool	No
IsAutorenew	body	bool	No
IsSuspended	body	bool?	No
SuspendStart	body	DateTime?	No
SuspendEnd	body	DateTime?	No
IsCancelled	body	bool?	No
EmailAddress	body	string	No
PhoneNumber	body	string	No
OrderItem_Id	body	long	No
ParentProductCategory_Id	body	long	No
Product_Id	body	long	No
ProductCategory_Id	body	long	No
Active	body	bool	No
UpdateType	body	string	No

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

**SubscriptionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<SubscriptionDto>	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

**SubscriptionDto** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Subtitle	form	string	No
IssuesRemaining	form	int	No
TotalIssues	form	int	No
FirstIssueDate	form	DateTime	No
StartDate	form	DateTime	No
StartDateDisplay	form	string	No
ExpirationDate	form	DateTime	No
ExpirationDateDisplay	form	string	No
ShipMethod	form	string	No
ActiveDaysRemaining	form	int	No
ListPrice	form	decimal	No
Price	form	decimal	No
FirstClassPrice	form	decimal	No
IsFirstClass	form	bool	No
SpecialPrice	form	decimal	No
SpecialPriceExpiration	form	DateTime?	No
IsOnline	form	bool	No
IsPrint	form	bool	No
IsRecurring	form	bool	No
NumberOfSeats	form	int	No
NextBillingDate	form	DateTime	No
LastChargeDate	form	DateTime	No
LastChargeSuccess	form	bool	No
IssueNow	form	bool	No
DoNotMail	form	bool	No
IsAutorenew	form	bool	No
IsSuspended	form	bool	No
SuspendStart	form	DateTime?	No
SuspendEnd	form	DateTime?	No
IsCancelled	form	bool	No
EmailAddress	form	string	No
PhoneNumber	form	string	No
Customer_Id	form	long	No
ParentProductCategory_Id	form	long	No
ProductCategory_Id	form	long	No
Product_Id	form	long	No
DateCreated	form	DateTime	No
LastRenewalDate	form	DateTime?	No
LastRenewalDateDisplay	form	string	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No

**SubscriptionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<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>