eBay · Schema
TopicSearchResponse
A type that describes the details of the topic search response.
AuctionsCommerceProductsMarketplaceFortune 500
Properties
| Name | Type | Description |
|---|---|---|
| href | string | The path to the call URI that produced the current page of results. |
| limit | integer | The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the met |
| next | string | The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can |
| topics | array | An array of topics that match the specified criteria. |
| total | integer | The total number of matches for the search criteria. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/TopicSearchResponse",
"title": "TopicSearchResponse",
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The path to the call URI that produced the current page of results."
},
"limit": {
"type": "integer",
"description": "The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the method.<br><br><span class=\"tablenote\"><b>Note:</b> Though this parameter is not required to be submitted in the request, the parameter defaults to <code>20</code> if omitted.</span>",
"format": "int32"
},
"next": {
"type": "string",
"description": "The URL to access the next set of results. This field includes a <strong>continuation_token</strong>. No <b>prev</b> field is returned, but this value is persistent during the session so that you can use it to return to the next page.<br><br>This field is not returned if fewer records than specified by the <strong>limit</strong> field are returned."
},
"topics": {
"type": "array",
"description": "An array of topics that match the specified criteria.",
"items": {
"$ref": "#/components/schemas/Topic"
}
},
"total": {
"type": "integer",
"description": "The total number of matches for the search criteria.",
"format": "int32"
}
},
"description": "A type that describes the details of the topic search response."
}