What is the endpoint for [P042]Fulltext Image?

The [P042]Fulltext Image endpoint is POST https://connect.patsnap.com/basic-patent-data/fulltext-image.

Where can I find the OpenAPI schema for [P042]Fulltext Image?

The OpenAPI schema is available at /openapi.json#/paths/~1basic-patent-data~1fulltext-image/post. You can also browse the full specification at /openapi.json.

[P042]Fulltext Image

Q: What data can [P042]Fulltext Image return?

[P042]Fulltext Image Receive patent fulltext image data by patent_id or patent_number. Patent fulltext data includes fulltext image type and fulltext image URL path. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/basic-patent-data/fulltext-image

Try in Sandbox

Receive patent fulltext image data by patent_id or patent_number. Patent fulltext data includes fulltext image type and fulltext image URL path.

There must be one of the two request parameters of patent_id or patent_number, if there are multiple request parameters at the same time, the priority is patent_id>patent_number. The path is valid for 9 hour and will be emptied after expiration.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`patent_id`	`string`	`fdbca633-63df-4c0b-8597-3f6c5e3a2748`	patent id
`offset` Required	`integer<int32>`	-	offset value, default value 0
`patent_number`	`string`	`CN116420141A`	patent number
`limit` Required	`integer<int32>`	`100`	limit of returned response, maximum value 100, default value 100

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`pn`	`string`	`CN116420141A`	patent number
`patent_id`	`string`	`fdbca633-63df-4c0b-8597-3f6c5e3a2748`	patent id
`result_count`	`integer<int32>`	`9`	Received result count
`fulltext_image`	`array`	`Please check the form: FullTextImage`	fulltext image
`path`	`string`	https://imagefulltext.cdn.patsnap.com/CN/A/11/64/20/14/1/HDA0004204487520000011.png?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vaW1hZ2VmdWxsdGV4dC5jZG4ucGF0c25hcC5jb20vQ04vQS8xMS82NC8yMC8xNC8xL0hEQTAwMDQyMDQ0ODc1MjAwMDAwMTEucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNjg5NzU5OTc4fSwiSXBBZGRyZXNzIjp7IkFXUzpTb3VyY2VJcCI6IjAuMC4wLjAvMCJ9fX1dfQ__&Signature=S~Q6SepgmAUeGpWeUABJbC9Kc12URSxbhkY9zBApF5wRmm~cxj~HUgGEtXgtiTEMfgptv~58YE3OaJMvYLCkQAY5cxvNg5Fz~GFunxta5bEEObhX5H9jPb92INmrNkbcyFsCDw8EWs2sYl8o1rYY8VSQEnqsUNtnh2XHS3j7Tzs7~408IICBvcPhEfYq-U-wGs49gdCwEnH3kfgrVorquq1pELnylyoOlSvRX0tBS~n7fnbdA-tqfPVVeH68BRxX5g8sEnn-Sow6V3UnuHv7018LYM5B2QdeNo64JRHAvypjvIY9Q~511oR2TRB6eU4agFIEvz~GDS~XK~Vwxj90Sw__&Key-Pair-Id=APKAI44SYS6CW72N3U2Q	fulltext image path
`image_type`	`string`	`drawings`	fulltext image type
`total_search_result_count`	`integer<int32>`	`9`	Total search result count
`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": {
    "pn": "CN116420141A",
    "patent_id": "fdbca633-63df-4c0b-8597-3f6c5e3a2748",
    "result_count": 9,
    "fulltext_image": [
      {
        "path": "https://imagefulltext.cdn.patsnap.com/CN/A/11/64/20/14/1/HDA0004204487520000011.png?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vaW1hZ2VmdWxsdGV4dC5jZG4ucGF0c25hcC5jb20vQ04vQS8xMS82NC8yMC8xNC8xL0hEQTAwMDQyMDQ0ODc1MjAwMDAwMTEucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNjg5NzU5OTc4fSwiSXBBZGRyZXNzIjp7IkFXUzpTb3VyY2VJcCI6IjAuMC4wLjAvMCJ9fX1dfQ__&Signature=S~Q6SepgmAUeGpWeUABJbC9Kc12URSxbhkY9zBApF5wRmm~cxj~HUgGEtXgtiTEMfgptv~58YE3OaJMvYLCkQAY5cxvNg5Fz~GFunxta5bEEObhX5H9jPb92INmrNkbcyFsCDw8EWs2sYl8o1rYY8VSQEnqsUNtnh2XHS3j7Tzs7~408IICBvcPhEfYq-U-wGs49gdCwEnH3kfgrVorquq1pELnylyoOlSvRX0tBS~n7fnbdA-tqfPVVeH68BRxX5g8sEnn-Sow6V3UnuHv7018LYM5B2QdeNo64JRHAvypjvIY9Q~511oR2TRB6eU4agFIEvz~GDS~XK~Vwxj90Sw__&Key-Pair-Id=APKAI44SYS6CW72N3U2Q",
        "image_type": "drawings"
      }
    ],
    "total_search_result_count": 9
  },
  "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
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!

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