What is the endpoint for [P071]Classification Number Assistant Query?

The [P071]Classification Number Assistant Query endpoint is GET https://connect.patsnap.com/search/patent/classification/helper-section-subclass.

Where can I find the OpenAPI schema for [P071]Classification Number Assistant Query?

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

[P071]Classification Number Assistant Query

Q: What data can [P071]Classification Number Assistant Query return?

[P071]Classification Number Assistant Query This interface supports querying the list of all subcategories of each type of classification (supporting IPC, CPC, LOC). See the Response Schema and Success Response Example on this page for the full structure.

get

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

Try in Sandbox

This interface supports querying the list of all subcategories of each type of classification (supporting IPC, CPC, LOC).

code passes the parameter null, and by default, it queries the first-level classification list. If specific parameters are passed, only the list of all subcategories at the next level will be queried.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`code`	`string`	`A`	Classification Number
`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`	`array`	-	response data
`id`	`string`	`A`	Classification code
`has_children`	`boolean`	`true`	has children nodes
`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": [
    {
      "id": "A",
      "has_children": true,
      "lang_desc_map": {
        "cn": "人类生活必需",
        "en": "HUMAN NECESSITIES"
      }
    }
  ],
  "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