Cdn API

<back to all web services

TypeSenseCollectibleRequest

TypeSenseCollectibleRequest Parameters:
NameParameterData TypeRequiredDescription
CatalogquerystringNo
KeywordsquerystringNo
PagequeryintNo
PerPagequeryintNo
SortquerystringNo
DatesquerystringNo
TypeSenseSearchResponse<T> Parameters:
NameParameterData TypeRequiredDescription
facet_countsformList<FacetCount>No
foundformintNo
hitsformList<TypeSenseHit<'T>>No
out_offormintNo
pageformintNo
request_paramsformTypeSenseRequestParamsNo
search_cutoffformboolNo
search_time_msformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
FacetCount Parameters:
NameParameterData TypeRequiredDescription
countsformList<TypeSenseCount>No
field_nameformstringNo
statsformTypeSenseStatNo
TypeSenseCount Parameters:
NameParameterData TypeRequiredDescription
countformintNo
highlightedformstringNo
valueformstringNo
TypeSenseStat Parameters:
NameParameterData TypeRequiredDescription
total_valuesformintNo
avgformdouble?No
maxformdouble?No
minformdouble?No
sumformdouble?No
TypeSenseRequestParams Parameters:
NameParameterData TypeRequiredDescription
collection_nameformstringNo
per_pageformintNo
qformstringNo

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.

POST /jsv/reply/TypeSenseCollectibleRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Catalog: String,
	Keywords: String,
	Page: 0,
	PerPage: 0,
	Sort: String,
	Dates: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	facet_counts: 
	[
		{
			counts: 
			[
				{
					count: 0,
					highlighted: String,
					value: String
				}
			],
			field_name: String,
			stats: 
			{
				total_values: 0,
				avg: 0,
				max: 0,
				min: 0,
				sum: 0
			}
		}
	],
	found: 0,
	hits: 
	[
		{
			document: 
			{
				BnbNumber: String,
				Catalog: String,
				CatalogSort: 0,
				Catalog_id: 0,
				CoinDate: String,
				Denomination: String,
				Description: String,
				Designation: String,
				Designer: String,
				EntryImageSource: String,
				EntryImageUrl: String,
				EntryName: String,
				EntrySort: 0,
				Group: String,
				GroupSort: 0,
				Group_id: 0,
				Id: 0,
				GsId: 0,
				IsSet: False,
				IsType: False,
				MintMark: String,
				PcgsNumber: String,
				PickNumber: String,
				Series: String,
				SeriesSort: 0,
				Series_id: 0,
				SortOrder: 0,
				Prefix: String,
				PriceHigh: 0,
				PriceLow: 0,
				GroupPermalink: String,
				SeriesPermalink: String,
				UiParentId: 0
			}
		}
	],
	out_of: 0,
	page: 0,
	request_params: 
	{
		collection_name: String,
		per_page: 0,
		q: String
	},
	search_cutoff: False,
	search_time_ms: 0,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}