| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Catalog | query | string | No | |
| Keywords | query | string | No | |
| Page | query | int | No | |
| PerPage | query | int | No | |
| Sort | query | string | No | |
| Dates | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| facet_counts | form | List<FacetCount> | No | |
| found | form | int | No | |
| hits | form | List<TypeSenseHit<'T>> | No | |
| out_of | form | int | No | |
| page | form | int | No | |
| request_params | form | TypeSenseRequestParams | No | |
| search_cutoff | form | bool | No | |
| search_time_ms | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| counts | form | List<TypeSenseCount> | No | |
| field_name | form | string | No | |
| stats | form | TypeSenseStat | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| count | form | int | No | |
| highlighted | form | string | No | |
| value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| total_values | form | int | No | |
| avg | form | double? | No | |
| max | form | double? | No | |
| min | form | double? | No | |
| sum | form | double? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| collection_name | form | string | No | |
| per_page | form | int | No | |
| q | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: mobileapidev.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,
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
}