What is the endpoint for [P072]Classification number search assistant interface?

The [P072]Classification number search assistant interface endpoint is GET https://connect.patsnap.com/search/patent/classification/helper-search.

Where can I find the OpenAPI schema for [P072]Classification number search assistant interface?

The OpenAPI schema is available at /openapi.json#/paths/~1search~1patent~1classification~1helper-search/get. You can also browse the full specification at /openapi.json.

[P072]Classification number search assistant interface

Q: What data can [P072]Classification number search assistant interface return?

[P072]Classification number search assistant interface Based on the retrieval content and the type of classification number assistant, obtain the classification level information related to the retrieval content. See the Response Schema and Success Response Example on this page for the full structure.

get

https://connect.patsnap.com/search/patent/classification/helper-search

Try in Sandbox

Based on the retrieval content and the type of classification number assistant, obtain the classification level information related to the retrieval content

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`keyword` Required	`string`	`手机`	Classified retrieval content
`type` Required	`string`	`ipc`	The classification number assistant category includes ipc, cpc, and loc

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`h_words`	`array`	`[ "手机", "电脑" ]`	Key word hit
`has_children`	`string`	`true`	has children nodes
`query_results`	`array`	`Please check the form: QueryResults`	search results
`cls_tree`	`object`	`Please check the form: ClassificationTree`	Classification number hierarchy tree
`id`	`string`	`A`	Classification code
`children`	`array`	`Please check the form: ClassificationTree`	sub Classification number hierarchy tree
`lang_desc_map`	`object`	`Please check the form: LangDescMap`	Description in both Chinese and English
`cn`	`string`	`人类生活必需`	Chinese description
`en`	`string`	`HUMAN NECESSITIES`	English description
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "h_words": [
      "手机",
      "电脑"
    ],
    "has_children": true,
    "query_results": [
      {
        "cls_tree": {
          "id": "A",
          "children": "ClassificationTree",
          "lang_desc_map": "LangDescMap"
        }
      }
    ]
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms