[P004]Original Applicant Search
Receive original assignee (applicant) patent data. This includes patent count, patent number and patent ID.
Request Parameters
List of parameters supported by this API endpoint
| Name | Type | Example | Description |
|---|---|---|---|
| integer<int32> | - | offset value; limit + offset <= 20000 (the max number of Semantic Search is 1000) |
Required | string | Apple, Inc. | Standardized Original Assignee (Applicant) name, the search logic is the same as Analytics query [ANS:(Apple, Inc.)], up to 100 companies can be searched; multiple companies are separated by " OR ", e.g. "Apple OR Huawei" |
| integer<int32> | 10 | limit of returned response; must be <= 1,000 |
Response Schema
Structure of the API response data
| Field Name | Type | Example | Description |
|---|---|---|---|
data | object | - | response data |
results | array | Please check the form: PatentBaseResponse | result |
pn | string | US11205304B2 | patent number |
patent_id | string | 718ead9c-4f3c-4674-8f5a-24e126827269 | patent id |
result_count | integer<int32> | 10 | Received result count |
total_search_result_count | integer<int64> | 1000 | Total search result count |
statusRequired | boolean | false | Status |
error_msg | string | The request parameter format is incorrect! | Error Message |
error_codeRequired | integer | 0 | Error Code |
Success Response Example
Example of a successful API response
JSON
{
"data": {
"results": [
{
"pn": "US11205304B2",
"patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269"
}
],
"result_count": 10,
"total_search_result_count": 1000
},
"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 |