Cdn API - CPG Source

TypeSenseGetByIdRequest

Cdn.Api

The following routes are available for this service:
GET	/TypeSenseGetByIdRequest

**TypeSenseGetByIdRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	string	No

**TypeSenseGetByIdResponse** Parameters:
Name	Parameter	Data Type	Required
MarketplaceItem	form	MarketplaceItem	No
PricingToolDetail	form	PricingToolDetailResponse	No
News	form	List<NewsItem>	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

**MarketplaceItem** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
askId	form	int	No
userId	form	int	No
userCode	form	string	No
customerId	form	long	No
companyName	form	string	No
auctionHouseAbbrev	form	string	No
auctionHouseName	form	string	No
avatar	form	string	No
description	form	string	No
cdnxEntryCode	form	string	No
cdnEntryId	form	long	No
gsid	form	long	No
entryName	form	string	No
entryImageUrl	form	string	No
entryImageSource	form	string	No
grade	form	int	No
fullGrade	form	string	No
service	form	string	No
sightCode	form	string	No
callForPrice	form	bool	No
spotMessage	form	Object	No
spotBased	form	bool	No
spotPlusMinus	form	string	No
spotDollarPercent	form	string	No
spotOffset	form	int	No
quantity	form	int	No
extended	form	string	No
details	form	bool	No
error	form	bool	No
expireDate	form	string	No
lastModified	form	string	No
paperQuality	form	Object	No
isAuction	form	bool	No
auctionEnds	form	DateTime?	No
auctionSoldFor	form	float	No
url	form	string	No
isCac	form	bool	No
isSold	form	bool	No
aprId	form	long	No
rec_type	form	string	No
price	form	float	No
catalog_id	form	long	No
catalog	form	string	No
catalogSort	form	long	No
group_id	form	long	No
group	form	string	No
groupSort	form	long	No
series_id	form	long	No
series	form	string	No
seriesSort	form	long	No
entrySort	form	long	No
sortOrder	form	long	No
images	form	List<string>	No
views	form	int	No
itemSource	form	string	No
sortString	form	string	No

**PricingToolDetailResponse** Parameters:
Name	Parameter	Data Type	Required
EntryData	form	CatalogEntryDto	No
Title	form	string	No
DisplayTitle	form	string	No
BaseTitle	form	string	No
RetailCpg	form	string	No
RetailCpgPrev	form	string	No
RetailCpgPrevDate	form	string	No
RetailCpgPlusMinusValue	form	string	No
RetailGrey	form	string	No
RetailGreyPrev	form	string	No
RetailGreyPrevDate	form	string	No
RetailGreyPlusMinusValue	form	string	No
RetailBlueP	form	string	No
RetailBluePPrev	form	string	No
RetailBluePPrevDate	form	string	No
RetailBluePPlusMinusValue	form	string	No
RetailBlueN	form	string	No
RetailBlueNPrev	form	string	No
RetailBlueNPrevDate	form	string	No
RetailBlueNPlusMinusValue	form	string	No
RetailGreen	form	string	No
RetailGreenPrev	form	string	No
RetailGreenPrevDate	form	string	No
RetailGreenPlusMinusValue	form	string	No
AllowedPublications	form	string	No
ShowGrey	form	bool	No
ShowBlue	form	bool	No
ShowGreen	form	bool	No
CatalogId	form	long	No
SeriesId	form	long	No
SeriesName	form	string	No
SeriesPermalink	form	string	No
PcgsNum	form	string	No
Grade	form	int	No
CpgChartData	form	List<HistoryChartData>	No
GreyChartData	form	List<HistoryChartData>	No
BluePChartData	form	List<HistoryChartData>	No
BlueNChartData	form	List<HistoryChartData>	No
GreenChartData	form	List<HistoryChartData>	No
MergedChartData	form	List<HistoricalChartDataMerged>	No
AprData	form	List<CdnxAprData>	No
AprDataTotal	form	int	No
AllowedCatalogsRetail	form	string	No
AllowedCatalogsWholesale	form	string	No
AllowRetail	form	bool	No
AllowWholesale	form	bool	No
AccessRemaining	form	int	No
PermitAccess	form	bool	No

**CatalogEntryDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ParentId	form	long	No
UiParentId	form	long	No
ParentNodeId	form	long	No
IntRef	form	int	No
ParentIntRef	form	int	No
PcgsNumber	form	string	No
Title	form	string	No
WebsiteTitle	form	string	No
DisplayTitle	form	string	No
CoinDate	form	string	No
DenominationShort	form	string	No
DenominationLong	form	string	No
Variety	form	string	No
Variety2	form	string	No
Desg	form	string	No
Other	form	string	No
Prefix	form	string	No
MintMark	form	string	No
Composition	form	string	No
Mintage	form	string	No
StrikeType	form	string	No
CoinageType	form	string	No
CoinageYears	form	string	No
MintLocation	form	string	No
Diameter	form	string	No
Fineness	form	string	No
WeightGrams	form	string	No
WeightOunces	form	string	No
Designer	form	string	No
Edge	form	string	No
Rarity	form	string	No
ObverseDescription	form	string	No
ObverseDesigner	form	string	No
ObverseLettering	form	string	No
ReverseDescription	form	string	No
ReverseDesigner	form	string	No
ReverseLettering	form	string	No
GeneralNotes	form	string	No
GeneralCoinLettering	form	string	No
IssueMinYear	form	string	No
IssueMaxYear	form	string	No
CoinRulersName	form	string	No
CoinRulersGroup	form	string	No
CoinDenominationNameShort	form	string	No
CoinDenominationNameLong	form	string	No
CoinShape	form	string	No
LocaleSpecificYear	form	string	No
IsDemonitized	form	bool	No
BnBNumber	form	string	No
PickNumber	form	string	No
NoteColor	form	string	No
NoteDimension	form	string	No
Watermark	form	string	No
Printer	form	string	No
NoteSecurityThread	form	string	No
NotePaperType	form	string	No
BnbSignatureName1	form	string	No
BnbSignatureName2	form	string	No
BnbSignatureName3	form	string	No
CgcNumber	form	long	No
ComicTitle	form	string	No
IssueNumber	form	string	No
IssueMonth	form	int	No
IssueYear	form	int	No
IssueDate	form	string	No
Variant	form	string	No
ArtComment1	form	string	No
ArtComment2	form	string	No
ArtComment3	form	string	No
KeyComment1	form	string	No
KeyComment2	form	string	No
KeyComment3	form	string	No
Krause	form	string	No
CoinPlex	form	string	No
Ngc	form	string	No
NumistaId	form	long	No
EbayCategory1	form	int	No
EbayCategory2	form	int	No
CdnValid	form	bool	No
PrintGreyValid	form	bool	No
PrintCpgValid	form	bool	No
CdnLabel	form	string	No
IsType	form	bool	No
IsSet	form	bool	No
ImageUrl	form	string	No
ImageUrlSource	form	string	No
ImageId	form	long	No
Permalink	form	string	No
CdnPublicationId	form	string	No
SortOrder	form	int	No
FlattenedCatalogSortOrder	form	int	No
Active	form	bool	No
AspectRatio	form	decimal	No
PriceLow	form	decimal	No
PriceHigh	form	decimal	No
SourceCdnCustomerId	form	long	No
SourceLinkUrl	form	string	No
SourceAvatarUrl	form	string	No
SeriesId	form	long	No
SeriesName	form	string	No
PrintSeriesName	form	string	No
SeriesPermalink	form	string	No
SeriesEbayEpnUrl	form	string	No
SeriesEbayAdDataId	form	string	No
HaUrl	form	string	No
DlrcUrl	form	string	No
GroupId	form	long	No
GroupName	form	string	No
GroupPermalink	form	string	No
GroupEbayEpnUrl	form	string	No
GroupEbayAdDataId	form	string	No
XCatalogId	form	long	No
CatalogName	form	string	No
CatalogPermalink	form	string	No
CatalogEbayEpnUrl	form	string	No
CatalogEbayAdDataId	form	string	No
Images	form	List<CatalogImageDto>	No

**CatalogImageDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Title	form	string	No
ImageUrl	form	string	No
ImageSource	form	string	No
SortOrder	form	int	No
LotNumber	form	int	No
SaleNumber	form	int	No
Grade	form	int	No
GradingService	form	string	No
ItemUrl	form	string	No
ItemDescription	form	string	No
AuctionHouse	form	string	No
SaleName	form	string	No
Base64ImageString	form	string	No
PriceRealized	form	decimal	No
SellDate	form	DateTime?	No
IsCac	form	bool	No
IsPlus	form	bool	No
IsStar	form	bool	No
IsSold	form	bool	No
IsFeatured	form	bool	No
IsObverse	form	bool	No
IsReverse	form	bool	No
IsSlab	form	bool	No
IsDetails	form	bool	No
IsError	form	bool	No
IsRelated	form	bool	No
CatalogId	form	long	No
GroupId	form	long	No
SeriesId	form	long	No
EntryIds	form	string	No
EntrySort	form	int	No
Active	form	bool	No
AspectRatio	form	decimal	No

**HistoryChartData** Parameters:
Name	Parameter	Data Type	Required
PriceDate	form	DateTime	No
PriceDateDisplay	form	string	No
Price	form	decimal	No
PlusMinus	form	string	No

**HistoricalChartDataMerged** Parameters:
Name	Parameter	Data Type	Required
PriceDate	form	DateTime	No
PriceDateDisplay	form	string	No
PriceCpg	form	decimal	No
PriceGrey	form	decimal	No
PriceBlueP	form	decimal	No
PriceBlueN	form	decimal	No
PriceGreen	form	decimal	No
PriceApr	form	decimal	No
AprAuctionHouse	form	string	No

**CdnxAprData** Parameters:
Name	Parameter	Data Type	Required
AprId	form	long	No
CdnxEntryCode	form	string	No
CdnEntryId	form	long?	No
EntryName	form	string	No
Grade	form	string	No
InternalGrade	form	int	No
AuctionHouseAbbrev	form	string	No
AuctionHouseName	form	string	No
SaleDate	form	DateTime	No
Description	form	string	No
Amount	form	decimal	No
Service	form	string	No
IsCac	form	bool	No
SaleName	form	string	No
LinkUrl	form	string	No
IsSold	form	bool	No
Images	form	List<string>	No

**NewsItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
PostSummary	form	string	No
PostTitle	form	string	No
Categories	form	List<string>	No
Author	form	string	No
SortOrder	form	int	No
ImageCaption	form	string	No
ImageUrl	form	string	No
Permalink	form	string	No
PostContent	form	string	No
PostDate	form	DateTime	No

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

HTTP + JSV

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

GET /TypeSenseGetByIdRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv

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

{
	MarketplaceItem: 
	{
		id: String,
		askId: 0,
		userId: 0,
		userCode: String,
		customerId: 0,
		companyName: String,
		auctionHouseAbbrev: String,
		auctionHouseName: String,
		avatar: String,
		description: String,
		cdnxEntryCode: String,
		cdnEntryId: 0,
		gsid: 0,
		entryName: String,
		entryImageUrl: String,
		entryImageSource: String,
		grade: 0,
		fullGrade: String,
		service: String,
		sightCode: String,
		callForPrice: False,
		spotMessage: {},
		spotBased: False,
		spotPlusMinus: String,
		spotDollarPercent: String,
		spotOffset: 0,
		quantity: 0,
		extended: String,
		details: False,
		error: False,
		expireDate: String,
		lastModified: String,
		paperQuality: {},
		isAuction: False,
		auctionEnds: 0001-01-01,
		auctionSoldFor: 0,
		url: String,
		isCac: False,
		isSold: False,
		aprId: 0,
		rec_type: String,
		price: 0,
		catalog_id: 0,
		catalog: String,
		catalogSort: 0,
		group_id: 0,
		group: String,
		groupSort: 0,
		series_id: 0,
		series: String,
		seriesSort: 0,
		entrySort: 0,
		sortOrder: 0,
		images: 
		[
			String
		],
		views: 0,
		itemSource: String,
		sortString: String
	},
	PricingToolDetail: 
	{
		EntryData: 
		{
			Id: 0,
			ParentId: 0,
			UiParentId: 0,
			ParentNodeId: 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: 0001-01-01,
					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
				}
			]
		},
		Title: String,
		DisplayTitle: String,
		BaseTitle: String,
		RetailCpg: String,
		RetailCpgPrev: String,
		RetailCpgPrevDate: String,
		RetailCpgPlusMinusValue: String,
		RetailGrey: String,
		RetailGreyPrev: String,
		RetailGreyPrevDate: String,
		RetailGreyPlusMinusValue: String,
		RetailBlueP: String,
		RetailBluePPrev: String,
		RetailBluePPrevDate: String,
		RetailBluePPlusMinusValue: String,
		RetailBlueN: String,
		RetailBlueNPrev: String,
		RetailBlueNPrevDate: String,
		RetailBlueNPlusMinusValue: String,
		RetailGreen: String,
		RetailGreenPrev: String,
		RetailGreenPrevDate: String,
		RetailGreenPlusMinusValue: String,
		AllowedPublications: String,
		ShowGrey: False,
		ShowBlue: False,
		ShowGreen: False,
		CatalogId: 0,
		SeriesId: 0,
		SeriesName: String,
		SeriesPermalink: String,
		PcgsNum: String,
		Grade: 0,
		CpgChartData: 
		[
			{
				PriceDate: 0001-01-01,
				PriceDateDisplay: String,
				Price: 0,
				PlusMinus: String
			}
		],
		GreyChartData: 
		[
			{
				PriceDate: 0001-01-01,
				PriceDateDisplay: String,
				Price: 0,
				PlusMinus: String
			}
		],
		BluePChartData: 
		[
			{
				PriceDate: 0001-01-01,
				PriceDateDisplay: String,
				Price: 0,
				PlusMinus: String
			}
		],
		BlueNChartData: 
		[
			{
				PriceDate: 0001-01-01,
				PriceDateDisplay: String,
				Price: 0,
				PlusMinus: String
			}
		],
		GreenChartData: 
		[
			{
				PriceDate: 0001-01-01,
				PriceDateDisplay: String,
				Price: 0,
				PlusMinus: String
			}
		],
		MergedChartData: 
		[
			{
				PriceDate: 0001-01-01,
				PriceDateDisplay: String,
				PriceCpg: 0,
				PriceGrey: 0,
				PriceBlueP: 0,
				PriceBlueN: 0,
				PriceGreen: 0,
				PriceApr: 0,
				AprAuctionHouse: String
			}
		],
		AprData: 
		[
			{
				
			}
		],
		AprDataTotal: 0,
		AllowedCatalogsRetail: String,
		AllowedCatalogsWholesale: String,
		AllowRetail: False,
		AllowWholesale: False,
		AccessRemaining: 0,
		PermitAccess: False,
		Total: 0,
		OpCode: 0,
		ErrorText: String,
		RequestTime: String,
		ResponseTime: String,
		TotalExecutionTime: String,
		CachedResponse: False
	},
	News: 
	[
		{
			Id: 0,
			PostSummary: String,
			PostTitle: String,
			Categories: 
			[
				String
			],
			Author: String,
			SortOrder: 0,
			ImageCaption: String,
			ImageUrl: String,
			Permalink: String,
			PostContent: String,
			PostDate: 0001-01-01
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}