Cdn API - CPG Source

<back to all web services

CatalogRequest

Cdn.Api

The following routes are available for this service:
GET/CatalogRequest
CatalogRequest Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
CatalogNamequerystringNo
DisplayNamequerystringNo
DescriptionquerystringNo
PermalinkquerystringNo
ImageUrlquerystringNo
SortOrderqueryintNo
CdnValidqueryboolNo
IncludeDeletedqueryboolNo
IncludeCdnInvalidqueryboolNo
ModifiedDaysqueryintNo
CatalogResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CatalogDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
CatalogDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DescriptionformstringNo
CatalogNameformstringNo
DisplayNameformstringNo
SortOrderformintNo
PermalinkformstringNo
ImageUrlformstringNo
ImageUrlSourceformstringNo
ImageIdformlongNo
PricingTileLabelformstringNo
PricingTilePermalinkformstringNo
NumChildrenformintNo
ActiveformboolNo
AspectRatioformdecimalNo
EbayCategoryformintNo
EbayAdDataIdformstringNo
EbayEpnUrlformstringNo
GroupsformList<CatalogGroupDto>No
ImagesformList<CatalogImageDto>No
CatalogGroupDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GroupNameformstringNo
DisplayNameformstringNo
NameformstringNo
LongNameformstringNo
CatalogDescriptionformstringNo
GroupDescriptionformstringNo
ImageUrlformstringNo
ImageUrlSourceformstringNo
ImageIdformlongNo
SortOrderformintNo
PermalinkformstringNo
FlagCodeformstringNo
CountryNameformstringNo
IntroEpsFileformstringNo
EpilogueEpsFileformstringNo
InBetweenCoverImageUrlformstringNo
XCatalogIdformlongNo
CatalogNameformstringNo
NumChildrenformintNo
AspectRatioformdecimalNo
EbayCategoryformintNo
EbayAdDataIdformstringNo
EbayEpnUrlformstringNo
ActiveformboolNo
CatalogSeriesformList<CatalogSeriesDto>No
ImagesformList<CatalogImageDto>No
CatalogSeriesDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SeriesNameformstringNo
NameformstringNo
SortOrderformintNo
PermalinkformstringNo
DescriptionformstringNo
ImageUrlformstringNo
ImageUrlSourceformstringNo
ImageIdformlongNo
EbayTitleformstringNo
HaUrlformstringNo
DlrcUrlformstringNo
CoinWorldCategoryformstringNo
AmazonCategoryformstringNo
AmazonDenominationformstringNo
AmazonTimePeriodformstringNo
ValidGradesformstringNo
ValidGradesCpgformstringNo
DecimalGradesformstringNo
EbayCategoryformintNo
EbayAdDataIdformstringNo
EbayEpnUrlformstringNo
GroupIdformlongNo
GroupNameformstringNo
GroupPermalinkformstringNo
XCatalogIdformlongNo
CatalogNameformstringNo
CatalogPermalinkformstringNo
NumChildrenformintNo
ActiveformboolNo
CdnValidformboolNo
AspectRatioformdecimalNo
CatalogEntriesformList<CatalogEntryDto>No
ImagesformList<CatalogImageDto>No
CatalogEntryDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ParentIdformlongNo
UiParentIdformlongNo
IntRefformintNo
ParentIntRefformintNo
PcgsNumberformstringNo
TitleformstringNo
WebsiteTitleformstringNo
DisplayTitleformstringNo
CoinDateformstringNo
DenominationShortformstringNo
DenominationLongformstringNo
VarietyformstringNo
Variety2formstringNo
DesgformstringNo
OtherformstringNo
PrefixformstringNo
MintMarkformstringNo
CompositionformstringNo
MintageformstringNo
StrikeTypeformstringNo
CoinageTypeformstringNo
CoinageYearsformstringNo
MintLocationformstringNo
DiameterformstringNo
FinenessformstringNo
WeightGramsformstringNo
WeightOuncesformstringNo
DesignerformstringNo
EdgeformstringNo
RarityformstringNo
ObverseDescriptionformstringNo
ObverseDesignerformstringNo
ObverseLetteringformstringNo
ReverseDescriptionformstringNo
ReverseDesignerformstringNo
ReverseLetteringformstringNo
GeneralNotesformstringNo
GeneralCoinLetteringformstringNo
IssueMinYearformstringNo
IssueMaxYearformstringNo
CoinRulersNameformstringNo
CoinRulersGroupformstringNo
CoinDenominationNameShortformstringNo
CoinDenominationNameLongformstringNo
CoinShapeformstringNo
LocaleSpecificYearformstringNo
IsDemonitizedformboolNo
BnBNumberformstringNo
PickNumberformstringNo
NoteColorformstringNo
NoteDimensionformstringNo
WatermarkformstringNo
PrinterformstringNo
NoteSecurityThreadformstringNo
NotePaperTypeformstringNo
BnbSignatureName1formstringNo
BnbSignatureName2formstringNo
BnbSignatureName3formstringNo
CgcNumberformlongNo
ComicTitleformstringNo
IssueNumberformstringNo
IssueMonthformintNo
IssueYearformintNo
IssueDateformstringNo
VariantformstringNo
ArtComment1formstringNo
ArtComment2formstringNo
ArtComment3formstringNo
KeyComment1formstringNo
KeyComment2formstringNo
KeyComment3formstringNo
KrauseformstringNo
CoinPlexformstringNo
NgcformstringNo
NumistaIdformlongNo
EbayCategory1formintNo
EbayCategory2formintNo
CdnValidformboolNo
PrintGreyValidformboolNo
PrintCpgValidformboolNo
CdnLabelformstringNo
IsTypeformboolNo
IsSetformboolNo
ImageUrlformstringNo
ImageUrlSourceformstringNo
ImageIdformlongNo
PermalinkformstringNo
CdnPublicationIdformstringNo
SortOrderformintNo
FlattenedCatalogSortOrderformintNo
ActiveformboolNo
AspectRatioformdecimalNo
PriceLowformdecimalNo
PriceHighformdecimalNo
SourceCdnCustomerIdformlongNo
SourceLinkUrlformstringNo
SourceAvatarUrlformstringNo
SeriesIdformlongNo
SeriesNameformstringNo
PrintSeriesNameformstringNo
SeriesPermalinkformstringNo
SeriesEbayEpnUrlformstringNo
SeriesEbayAdDataIdformstringNo
HaUrlformstringNo
DlrcUrlformstringNo
GroupIdformlongNo
GroupNameformstringNo
GroupPermalinkformstringNo
GroupEbayEpnUrlformstringNo
GroupEbayAdDataIdformstringNo
XCatalogIdformlongNo
CatalogNameformstringNo
CatalogPermalinkformstringNo
CatalogEbayEpnUrlformstringNo
CatalogEbayAdDataIdformstringNo
ImagesformList<CatalogImageDto>No
CatalogImageDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TitleformstringNo
ImageUrlformstringNo
ImageSourceformstringNo
SortOrderformintNo
LotNumberformintNo
SaleNumberformintNo
GradeformintNo
GradingServiceformstringNo
ItemUrlformstringNo
ItemDescriptionformstringNo
AuctionHouseformstringNo
SaleNameformstringNo
Base64ImageStringformstringNo
PriceRealizedformdecimalNo
SellDateformDateTime?No
IsCacformboolNo
IsPlusformboolNo
IsStarformboolNo
IsSoldformboolNo
IsFeaturedformboolNo
IsObverseformboolNo
IsReverseformboolNo
IsSlabformboolNo
IsDetailsformboolNo
IsErrorformboolNo
IsRelatedformboolNo
CatalogIdformlongNo
GroupIdformlongNo
SeriesIdformlongNo
EntryIdsformstringNo
EntrySortformintNo
ActiveformboolNo
AspectRatioformdecimalNo

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.

GET /CatalogRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"Id":0,"Description":"String","CatalogName":"String","DisplayName":"String","SortOrder":0,"Permalink":"String","ImageUrl":"String","ImageUrlSource":"String","ImageId":0,"PricingTileLabel":"String","PricingTilePermalink":"String","NumChildren":0,"Active":false,"AspectRatio":0,"EbayCategory":0,"EbayAdDataId":"String","EbayEpnUrl":"String","Groups":[{"Id":0,"GroupName":"String","DisplayName":"String","Name":"String","LongName":"String","CatalogDescription":"String","GroupDescription":"String","ImageUrl":"String","ImageUrlSource":"String","ImageId":0,"SortOrder":0,"Permalink":"String","FlagCode":"String","CountryName":"String","IntroEpsFile":"String","EpilogueEpsFile":"String","InBetweenCoverImageUrl":"String","XCatalogId":0,"CatalogName":"String","NumChildren":0,"AspectRatio":0,"EbayCategory":0,"EbayAdDataId":"String","EbayEpnUrl":"String","Active":false,"CatalogSeries":[{"Id":0,"SeriesName":"String","Name":"String","SortOrder":0,"Permalink":"String","Description":"String","ImageUrl":"String","ImageUrlSource":"String","ImageId":0,"EbayTitle":"String","HaUrl":"String","DlrcUrl":"String","CoinWorldCategory":"String","AmazonCategory":"String","AmazonDenomination":"String","AmazonTimePeriod":"String","ValidGrades":"String","ValidGradesCpg":"String","DecimalGrades":"String","EbayCategory":0,"EbayAdDataId":"String","EbayEpnUrl":"String","GroupId":0,"GroupName":"String","GroupPermalink":"String","XCatalogId":0,"CatalogName":"String","CatalogPermalink":"String","NumChildren":0,"Active":false,"CdnValid":false,"AspectRatio":0,"CatalogEntries":[{"Id":0,"ParentId":0,"UiParentId":0,"IntRef":0,"ParentIntRef":0,"PcgsNumber":"String","Title":"String","WebsiteTitle":"String","DisplayTitle":"String","CoinDate":"String","DenominationShort":"String","DenominationLong":"String","Variety":"String","Variety2":"String","Desg":"String","Other":"String","Prefix":"String","MintMark":"String","Composition":"String","Mintage":"String","StrikeType":"String","CoinageType":"String","CoinageYears":"String","MintLocation":"String","Diameter":"String","Fineness":"String","WeightGrams":"String","WeightOunces":"String","Designer":"String","Edge":"String","Rarity":"String","ObverseDescription":"String","ObverseDesigner":"String","ObverseLettering":"String","ReverseDescription":"String","ReverseDesigner":"String","ReverseLettering":"String","GeneralNotes":"String","GeneralCoinLettering":"String","IssueMinYear":"String","IssueMaxYear":"String","CoinRulersName":"String","CoinRulersGroup":"String","CoinDenominationNameShort":"String","CoinDenominationNameLong":"String","CoinShape":"String","LocaleSpecificYear":"String","IsDemonitized":false,"BnBNumber":"String","PickNumber":"String","NoteColor":"String","NoteDimension":"String","Watermark":"String","Printer":"String","NoteSecurityThread":"String","NotePaperType":"String","BnbSignatureName1":"String","BnbSignatureName2":"String","BnbSignatureName3":"String","CgcNumber":0,"ComicTitle":"String","IssueNumber":"String","IssueMonth":0,"IssueYear":0,"IssueDate":"String","Variant":"String","ArtComment1":"String","ArtComment2":"String","ArtComment3":"String","KeyComment1":"String","KeyComment2":"String","KeyComment3":"String","Krause":"String","CoinPlex":"String","Ngc":"String","NumistaId":0,"EbayCategory1":0,"EbayCategory2":0,"CdnValid":false,"PrintGreyValid":false,"PrintCpgValid":false,"CdnLabel":"String","IsType":false,"IsSet":false,"ImageUrl":"String","ImageUrlSource":"String","ImageId":0,"Permalink":"String","CdnPublicationId":"String","SortOrder":0,"FlattenedCatalogSortOrder":0,"Active":false,"AspectRatio":0,"PriceLow":0,"PriceHigh":0,"SourceCdnCustomerId":0,"SourceLinkUrl":"String","SourceAvatarUrl":"String","SeriesId":0,"SeriesName":"String","PrintSeriesName":"String","SeriesPermalink":"String","SeriesEbayEpnUrl":"String","SeriesEbayAdDataId":"String","HaUrl":"String","DlrcUrl":"String","GroupId":0,"GroupName":"String","GroupPermalink":"String","GroupEbayEpnUrl":"String","GroupEbayAdDataId":"String","XCatalogId":0,"CatalogName":"String","CatalogPermalink":"String","CatalogEbayEpnUrl":"String","CatalogEbayAdDataId":"String","Images":[{"Id":0,"Title":"String","ImageUrl":"String","ImageSource":"String","SortOrder":0,"LotNumber":0,"SaleNumber":0,"Grade":0,"GradingService":"String","ItemUrl":"String","ItemDescription":"String","AuctionHouse":"String","SaleName":"String","Base64ImageString":"String","PriceRealized":0,"SellDate":"\/Date(-62135596800000-0000)\/","IsCac":false,"IsPlus":false,"IsStar":false,"IsSold":false,"IsFeatured":false,"IsObverse":false,"IsReverse":false,"IsSlab":false,"IsDetails":false,"IsError":false,"IsRelated":false,"CatalogId":0,"GroupId":0,"SeriesId":0,"EntryIds":"String","EntrySort":0,"Active":false,"AspectRatio":0}]}],"Images":[{"Id":0,"Title":"String","ImageUrl":"String","ImageSource":"String","SortOrder":0,"LotNumber":0,"SaleNumber":0,"Grade":0,"GradingService":"String","ItemUrl":"String","ItemDescription":"String","AuctionHouse":"String","SaleName":"String","Base64ImageString":"String","PriceRealized":0,"SellDate":"\/Date(-62135596800000-0000)\/","IsCac":false,"IsPlus":false,"IsStar":false,"IsSold":false,"IsFeatured":false,"IsObverse":false,"IsReverse":false,"IsSlab":false,"IsDetails":false,"IsError":false,"IsRelated":false,"CatalogId":0,"GroupId":0,"SeriesId":0,"EntryIds":"String","EntrySort":0,"Active":false,"AspectRatio":0}]}],"Images":[{"Id":0,"Title":"String","ImageUrl":"String","ImageSource":"String","SortOrder":0,"LotNumber":0,"SaleNumber":0,"Grade":0,"GradingService":"String","ItemUrl":"String","ItemDescription":"String","AuctionHouse":"String","SaleName":"String","Base64ImageString":"String","PriceRealized":0,"SellDate":"\/Date(-62135596800000-0000)\/","IsCac":false,"IsPlus":false,"IsStar":false,"IsSold":false,"IsFeatured":false,"IsObverse":false,"IsReverse":false,"IsSlab":false,"IsDetails":false,"IsError":false,"IsRelated":false,"CatalogId":0,"GroupId":0,"SeriesId":0,"EntryIds":"String","EntrySort":0,"Active":false,"AspectRatio":0}]}],"Images":[{"Id":0,"Title":"String","ImageUrl":"String","ImageSource":"String","SortOrder":0,"LotNumber":0,"SaleNumber":0,"Grade":0,"GradingService":"String","ItemUrl":"String","ItemDescription":"String","AuctionHouse":"String","SaleName":"String","Base64ImageString":"String","PriceRealized":0,"SellDate":"\/Date(-62135596800000-0000)\/","IsCac":false,"IsPlus":false,"IsStar":false,"IsSold":false,"IsFeatured":false,"IsObverse":false,"IsReverse":false,"IsSlab":false,"IsDetails":false,"IsError":false,"IsRelated":false,"CatalogId":0,"GroupId":0,"SeriesId":0,"EntryIds":"String","EntrySort":0,"Active":false,"AspectRatio":0}]}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}