What is the endpoint for [P066]Patent Classification Description?

The [P066]Patent Classification Description endpoint is POST https://connect.patsnap.com/high-value-data/patent-classification-description.

Where can I find the OpenAPI schema for [P066]Patent Classification Description?

The OpenAPI schema is available at /openapi.json#/paths/~1high-value-data~1patent-classification-description/post. You can also browse the full specification at /openapi.json.

[P066]Patent Classification Description

Q: What data can [P066]Patent Classification Description return?

[P066]Patent Classification Description Receive patent classification description data by corresponding classification type and code. Note: There must be all of the two request parameters of classification type and code. The API supports batch requests with a maximum of 10 classification codes of one type, and more classification codes are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned. . See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/high-value-data/patent-classification-description

Try in Sandbox

Receive patent classification description data by corresponding classification type and code.

Note: There must be all of the two request parameters of classification type and code. The API supports batch requests with a maximum of 10 classification codes of one type, and more classification codes are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.

Receive patent classification description data by corresponding classification type and code.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`code` Required	`string`	`C08G69/32`	patent classification code, character length <= 150. Batch requests needs to be <= 10 classification codes, and separated by English commas
`replace_by_merge`	`integer<int32>`	`1`	When the current patent classification type is ipc or cpc, should historical data be used as a substitute? Default substitution: 1: Yes 0: No.
`type` Required	`string`	`ipc`	patent classification type, character length <= 5 enumeration value: ipc, cpc, upc, gbc, loc, fi, fterm

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`code`	`string`	`C08G69/32`	patent classification code
`desc`	`array`	`desc`	patent classification description
`lang`	`string`	`EN`	patent classification description language
`text`	`string`	`... from aromatic diamines and aromatic dicarboxylic acids with both amino and carboxylic groups aromatically bound [2006.01]`	patent classification description text
`type`	`string`	`ipc`	patent classification type, character length <= 5 enumeration value: ipc, cpc, upc, gbc, loc, fi, fterm
`parent`	`array`	`parent`	parent classification information
`desc`	`array`	`desc`	parent patent classification description
`parent_code`	`string`	`EN`	parent patent classification code
`version`	`string`	`2024.01`	patent classification version
`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": [
    {
      "code": "C08G69/32",
      "desc": [
        {
          "lang": "EN",
          "text": "... from aromatic diamines and aromatic dicarboxylic acids with both amino and carboxylic groups aromatically bound [2006.01]"
        }
      ],
      "type": "ipc",
      "parent": [
        {
          "desc": [
            {
              "lang": "EN",
              "text": "... from aromatic diamines and aromatic dicarboxylic acids with both amino and carboxylic groups aromatically bound [2006.01]"
            }
          ],
          "parent_code": "EN"
        }
      ],
      "version": 2024.01
    }
  ],
  "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
`201`	Created
`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