Cdn Mobile API

<back to all web services

TypeSenseSearchRequest

Cdn.MobileApi

The following routes are available for this service:
GET/TypeSenseSearchRequest
TypeSenseSearchRequest Parameters:
NameParameterData TypeRequiredDescription
SortquerystringNo
BaseTypeSenseSearchRequest Parameters:
NameParameterData TypeRequiredDescription
KeywordsformstringNo
PageformintNo
PerPageformintNo
FacetByformstringNo
FilterByformstringNo
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.

GET /TypeSenseSearchRequest HTTP/1.1 
Host: mobileapidevsw.greysheet.com 
Accept: text/jsv
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: 
			{
				id: String,
				askId: 0,
				userId: 0,
				userCode: String,
				customerId: 0,
				companyName: String,
				auctionHouseAbbrev: String,
				auctionHouseName: String,
				avatar: String,
				description: String,
				cdnxEntryCode: String,
				cdnEntryId: 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
			}
		}
	],
	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
}