Cdn API - CPG Source

<back to all web services

SubscriptionSeatRequest

Cdn.Api

The following routes are available for this service:
GET,POST,DELETE/SubscriptionSeatRequest
SubscriptionSeatRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodylongNo
SubscriptionIdbodylongNo
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 .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.

POST /SubscriptionSeatRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubscriptionSeatRequest 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>
  <CustomerId>0</CustomerId>
  <SubscriptionId>0</SubscriptionId>
</SubscriptionSeatRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<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>