Cdn Mobile API

<back to all web services

CategoriesGetRequest

CategoriesGetRequest Parameters:
NameParameterData TypeRequiredDescription
ActiveOnlyqueryboolNo
ShowBundlesqueryboolNo
ShowHiddenqueryboolNo
PermalinkquerystringNo
SkipCountsqueryboolNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
CategoryResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ProductCategoryDto>No
UniqueSubscribersformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
ProductCategoryDto Parameters:
NameParameterData TypeRequiredDescription
ProductCategoryNameformstringNo
DisplayNameformstringNo
SubTitleformstringNo
ProductCategoryDescriptionformstringNo
SubscriptionDescriptionformstringNo
FilePrefixformstringNo
IsSubscribableformboolNo
IsHiddenformboolNo
IssuesPerSubscriptionformintNo
RenewalTriggerformintNo
WebsiteTitleformstringNo
WebsiteMetaTitleformstringNo
WebsiteHeaderformstringNo
WebsiteIconformstringNo
WebsiteHighlightTextformstringNo
WebsiteInformationformstringNo
WebsiteAboutBoxformstringNo
WebsiteISSNformstringNo
WebsitePublicationInfoformstringNo
WebsiteSubscriptionInfoformstringNo
WebsiteReturnInfoformstringNo
WebsiteVideo1TitleformstringNo
WebsiteVideo1IdformstringNo
WebsiteVideo2TitleformstringNo
WebsiteVideo2IdformstringNo
WebsiteVideo3TitleformstringNo
WebsiteVideo3IdformstringNo
WebsiteKindleUrlformstringNo
WebsiteOnlineDisclaimerformstringNo
WebsitePrintDisclaimerformstringNo
WebsiteComboDisclaimerformstringNo
WebsiteSubscriptionDisclaimerformstringNo
WebsiteSingleDisclaimerformstringNo
WebsiteSubTitleformstringNo
WebsiteSubOrderPrefixformstringNo
WebsiteShipTitleOverrideformstringNo
WebsiteCarouselNameformstringNo
PermalinkformstringNo
PdfSampleformstringNo
KlaviyoNameformstringNo
SortOrderformintNo
NumberOfSubscribersformintNo
NumberOfSubscribersStdformintNo
NumberOfSubscribersFirstClassformintNo
NumberOfSubscribersInternationalformintNo
NumberOfSubscribersOnlineformintNo
NumberOfSubscribersComboformintNo
ShowNewBenefitBoxformboolNo
IsBundleformboolNo
ProductsformList<ProductDto>No
XProductCategoryFeaturesformList<XProductCategoryFeatureDto>No
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
ProductDto Parameters:
NameParameterData TypeRequiredDescription
ProductDisplayNameformstringNo
ProductNameformstringNo
SubTitleformstringNo
WebTitleformstringNo
WebLineItemTitleformstringNo
WebOnlinePlugformstringNo
WebPrintPlugformstringNo
WebComboPlugformstringNo
ShipMethodformstringNo
IssuesPerYearformintNo
OnlinePriceformdecimalNo
PrintedPriceformdecimalNo
ComboPriceformdecimalNo
OnlinePriceSaleformdecimalNo
PrintedPriceSaleformdecimalNo
ComboPriceSaleformdecimalNo
AllowFirstClassformboolNo
FirstClassPriceformdecimalNo
RenewalDiscountformdecimalNo
IsSubscribableformboolNo
IsSingleIssueformboolNo
IsTaxableformboolNo
IsTaxableEverywhereformboolNo
IsDealerTaxaExemptformboolNo
IsRecurringformboolNo
WebPurchaseableformboolNo
SortOrderformintNo
ProductCategoryformProductCategoryDtoNo
XProductCategoryFeatureDto Parameters:
NameParameterData TypeRequiredDescription
FeatureGroupformstringNo
FeatureTitleformstringNo
AccessOnlineRetailPricingformboolNo
AccessOnlineWholesalePricingformboolNo
GetPrintedPublicationformboolNo
PrintedPublicationDigitalOnlyformboolNo
CatalogsAllowedformstringNo
GroupSortOrderformintNo
SortOrderformintNo
CategoryResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ProductCategoryDto>No
UniqueSubscribersformintNo

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

HTTP + CSV

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

POST /csv/reply/CategoriesGetRequest HTTP/1.1 
Host: mobileapidevsw.greysheet.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ActiveOnly":false,"ShowBundles":false,"ShowHidden":false,"Permalink":"String","SkipCounts":false,"Id":0,"OrderBy":["String"],"OrderDirections":["Asc"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"ProductCategoryName":"String","DisplayName":"String","SubTitle":"String","ProductCategoryDescription":"String","SubscriptionDescription":"String","FilePrefix":"String","IsSubscribable":false,"IsHidden":false,"IssuesPerSubscription":0,"RenewalTrigger":0,"WebsiteTitle":"String","WebsiteMetaTitle":"String","WebsiteHeader":"String","WebsiteIcon":"String","WebsiteHighlightText":"String","WebsiteInformation":"String","WebsiteAboutBox":"String","WebsiteISSN":"String","WebsitePublicationInfo":"String","WebsiteSubscriptionInfo":"String","WebsiteReturnInfo":"String","WebsiteVideo1Title":"String","WebsiteVideo1Id":"String","WebsiteVideo2Title":"String","WebsiteVideo2Id":"String","WebsiteVideo3Title":"String","WebsiteVideo3Id":"String","WebsiteKindleUrl":"String","WebsiteOnlineDisclaimer":"String","WebsitePrintDisclaimer":"String","WebsiteComboDisclaimer":"String","WebsiteSubscriptionDisclaimer":"String","WebsiteSingleDisclaimer":"String","WebsiteSubTitle":"String","WebsiteSubOrderPrefix":"String","WebsiteShipTitleOverride":"String","WebsiteCarouselName":"String","Permalink":"String","PdfSample":"String","KlaviyoName":"String","SortOrder":0,"NumberOfSubscribers":0,"NumberOfSubscribersStd":0,"NumberOfSubscribersFirstClass":0,"NumberOfSubscribersInternational":0,"NumberOfSubscribersOnline":0,"NumberOfSubscribersCombo":0,"ShowNewBenefitBox":false,"IsBundle":false,"Products":[{"ProductDisplayName":"String","ProductName":"String","SubTitle":"String","WebTitle":"String","WebLineItemTitle":"String","WebOnlinePlug":"String","WebPrintPlug":"String","WebComboPlug":"String","ShipMethod":"String","IssuesPerYear":0,"OnlinePrice":0,"PrintedPrice":0,"ComboPrice":0,"OnlinePriceSale":0,"PrintedPriceSale":0,"ComboPriceSale":0,"AllowFirstClass":false,"FirstClassPrice":0,"RenewalDiscount":0,"IsSubscribable":false,"IsSingleIssue":false,"IsTaxable":false,"IsTaxableEverywhere":false,"IsDealerTaxaExempt":false,"IsRecurring":false,"WebPurchaseable":false,"SortOrder":0,"ProductCategory":{"ProductCategoryName":"String","DisplayName":"String","SubTitle":"String","ProductCategoryDescription":"String","SubscriptionDescription":"String","FilePrefix":"String","IsSubscribable":false,"IsHidden":false,"IssuesPerSubscription":0,"RenewalTrigger":0,"WebsiteTitle":"String","WebsiteMetaTitle":"String","WebsiteHeader":"String","WebsiteIcon":"String","WebsiteHighlightText":"String","WebsiteInformation":"String","WebsiteAboutBox":"String","WebsiteISSN":"String","WebsitePublicationInfo":"String","WebsiteSubscriptionInfo":"String","WebsiteReturnInfo":"String","WebsiteVideo1Title":"String","WebsiteVideo1Id":"String","WebsiteVideo2Title":"String","WebsiteVideo2Id":"String","WebsiteVideo3Title":"String","WebsiteVideo3Id":"String","WebsiteKindleUrl":"String","WebsiteOnlineDisclaimer":"String","WebsitePrintDisclaimer":"String","WebsiteComboDisclaimer":"String","WebsiteSubscriptionDisclaimer":"String","WebsiteSingleDisclaimer":"String","WebsiteSubTitle":"String","WebsiteSubOrderPrefix":"String","WebsiteShipTitleOverride":"String","WebsiteCarouselName":"String","Permalink":"String","PdfSample":"String","KlaviyoName":"String","SortOrder":0,"NumberOfSubscribers":0,"NumberOfSubscribersStd":0,"NumberOfSubscribersFirstClass":0,"NumberOfSubscribersInternational":0,"NumberOfSubscribersOnline":0,"NumberOfSubscribersCombo":0,"ShowNewBenefitBox":false,"IsBundle":false,"Products":[{"ProductDisplayName":"String","ProductName":"String","SubTitle":"String","WebTitle":"String","WebLineItemTitle":"String","WebOnlinePlug":"String","WebPrintPlug":"String","WebComboPlug":"String","ShipMethod":"String","IssuesPerYear":0,"OnlinePrice":0,"PrintedPrice":0,"ComboPrice":0,"OnlinePriceSale":0,"PrintedPriceSale":0,"ComboPriceSale":0,"AllowFirstClass":false,"FirstClassPrice":0,"RenewalDiscount":0,"IsSubscribable":false,"IsSingleIssue":false,"IsTaxable":false,"IsTaxableEverywhere":false,"IsDealerTaxaExempt":false,"IsRecurring":false,"WebPurchaseable":false,"SortOrder":0,"ProductCategory":{"ProductCategoryName":"String","DisplayName":"String","SubTitle":"String","ProductCategoryDescription":"String","SubscriptionDescription":"String","FilePrefix":"String","IsSubscribable":false,"IsHidden":false,"IssuesPerSubscription":0,"RenewalTrigger":0,"WebsiteTitle":"String","WebsiteMetaTitle":"String","WebsiteHeader":"String","WebsiteIcon":"String","WebsiteHighlightText":"String","WebsiteInformation":"String","WebsiteAboutBox":"String","WebsiteISSN":"String","WebsitePublicationInfo":"String","WebsiteSubscriptionInfo":"String","WebsiteReturnInfo":"String","WebsiteVideo1Title":"String","WebsiteVideo1Id":"String","WebsiteVideo2Title":"String","WebsiteVideo2Id":"String","WebsiteVideo3Title":"String","WebsiteVideo3Id":"String","WebsiteKindleUrl":"String","WebsiteOnlineDisclaimer":"String","WebsitePrintDisclaimer":"String","WebsiteComboDisclaimer":"String","WebsiteSubscriptionDisclaimer":"String","WebsiteSingleDisclaimer":"String","WebsiteSubTitle":"String","WebsiteSubOrderPrefix":"String","WebsiteShipTitleOverride":"String","WebsiteCarouselName":"String","Permalink":"String","PdfSample":"String","KlaviyoName":"String","SortOrder":0,"NumberOfSubscribers":0,"NumberOfSubscribersStd":0,"NumberOfSubscribersFirstClass":0,"NumberOfSubscribersInternational":0,"NumberOfSubscribersOnline":0,"NumberOfSubscribersCombo":0,"ShowNewBenefitBox":false,"IsBundle":false,"Products":[{"ProductDisplayName":"String","ProductName":"String","SubTitle":"String","WebTitle":"String","WebLineItemTitle":"String","WebOnlinePlug":"String","WebPrintPlug":"String","WebComboPlug":"String","ShipMethod":"String","IssuesPerYear":0,"OnlinePrice":0,"PrintedPrice":0,"ComboPrice":0,"OnlinePriceSale":0,"PrintedPriceSale":0,"ComboPriceSale":0,"AllowFirstClass":false,"FirstClassPrice":0,"RenewalDiscount":0,"IsSubscribable":false,"IsSingleIssue":false,"IsTaxable":false,"IsTaxableEverywhere":false,"IsDealerTaxaExempt":false,"IsRecurring":false,"WebPurchaseable":false,"SortOrder":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"XProductCategoryFeatures":[{"FeatureGroup":"String","FeatureTitle":"String","AccessOnlineRetailPricing":false,"AccessOnlineWholesalePricing":false,"GetPrintedPublication":false,"PrintedPublicationDigitalOnly":false,"CatalogsAllowed":"String","GroupSortOrder":0,"SortOrder":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"XProductCategoryFeatures":[{"FeatureGroup":"String","FeatureTitle":"String","AccessOnlineRetailPricing":false,"AccessOnlineWholesalePricing":false,"GetPrintedPublication":false,"PrintedPublicationDigitalOnly":false,"CatalogsAllowed":"String","GroupSortOrder":0,"SortOrder":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"XProductCategoryFeatures":[{"FeatureGroup":"String","FeatureTitle":"String","AccessOnlineRetailPricing":false,"AccessOnlineWholesalePricing":false,"GetPrintedPublication":false,"PrintedPublicationDigitalOnly":false,"CatalogsAllowed":"String","GroupSortOrder":0,"SortOrder":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"UniqueSubscribers":0,"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}