[L012]Literature Citation
Receive literature citation data by paper_id or doi.
One of the two parameters, paper_id and doi, is required; if both are passed, paper_id is preferred.The API supports batch requests with a maximum of 100 patents, and more patent id or patent number 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.
Request Parameters
List of parameters supported by this API endpoint
| Name | Type | Example | Description |
|---|---|---|---|
| string | 10.1016/j.bpj.2024.07.030 | DOI (only a single doi issupported) |
| integer<int32> | 1 | Current page number |
| string | 00001b6d-2cfa-411a-ab41-8a05fd675d46,00001756-243f-4738-a288-282987105915 | paper id |
Response Schema
Structure of the API response data
| Field Name | Type | Example | Description |
|---|---|---|---|
data | array | - | response data |
doi | string | 10.3390/s20030734 | DOI |
paper_id | string | 1f0f61d1-0d76-3a29-a677-7f0cf7a332f7,00001b6d-2cfa-411a-ab41-8a05fd675d46 | Paper ID |
reference_no | integer<int32> | 20 | Number of References |
np_citation_no | integer<int32> | 2 | Number of Non-patent Citations |
reference_data | array | Please check the form: LiteratureReference | Reference Data |
paper_id | string | 4590883d-3d89-35ef-b662-cd820dc1427c | Paper ID |
sequence | integer<int32> | 1 | Sequence |
citation_text | string | A review of infectious bovine rhinotracheitis, shipping fever pneumonia and viral-bacterial synergism in respiratory disease of cattle.W D Yates.Can J Comp Med.1982 Jul;46(3):225-63. | Citation Text |
np_citation_data | array | Please check the form: LiteratureNPCitation | Non-patent Citation data |
paper_id | string | 4b656503-a352-4815-93ba-76a7cb967d25 | Paper ID |
citation_text | string | A review of infectious bovine rhinotracheitis, shipping fever pneumonia and viral-bacterial synergism in respiratory disease of cattle.W D Yates.Can J Comp Med.1982 Jul;46(3):225-63. | Citation Text |
patent_citation_no | integer<int32> | 1 | Number of Patent Citations |
patent_citation_data | array | Please check the form: LiteraturePatentCitation | Patent Citation Data |
pn | string | CN112833870A | Patent Number |
apdt | integer<int32> | 20201230 | Application Date |
apno | string | CN202011610975.8 | Application Number |
pbdt | integer<int32> | 20201230 | Publication Date |
title | string | 核磁共振陀螺中抑制碱金属原子极化磁场影响的有效方法 | Title |
inventor | array | [
"张燚",
"汪之国",
"李佳佳"
] | Inventor |
patent_id | string | fd509ad5-7da1-464f-9b32-2858be00f2e9 | Patent ID |
current_assignee | array | [
"中国人民解放军国防科技大学"
] | Current Assignee |
original_assignee | array | [
"中国人民解放军国防科技大学"
] | Original Assignee |
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": [
{
"doi": "10.3390/s20030734",
"paper_id": "1f0f61d1-0d76-3a29-a677-7f0cf7a332f7,00001b6d-2cfa-411a-ab41-8a05fd675d46",
"reference_no": 20,
"np_citation_no": 2,
"reference_data": [
{
"paper_id": "4590883d-3d89-35ef-b662-cd820dc1427c",
"sequence": 1,
"citation_text": "A review of infectious bovine rhinotracheitis, shipping fever pneumonia and viral-bacterial synergism in respiratory disease of cattle.W D Yates.Can J Comp Med.1982 Jul;46(3):225-63."
}
],
"np_citation_data": [
{
"paper_id": "4b656503-a352-4815-93ba-76a7cb967d25",
"citation_text": "A review of infectious bovine rhinotracheitis, shipping fever pneumonia and viral-bacterial synergism in respiratory disease of cattle.W D Yates.Can J Comp Med.1982 Jul;46(3):225-63."
}
],
"patent_citation_no": 1,
"patent_citation_data": [
{
"pn": "CN112833870A",
"apdt": 20201230,
"apno": "CN202011610975.8",
"pbdt": 20201230,
"title": "核磁共振陀螺中抑制碱金属原子极化磁场影响的有效方法",
"inventor": [
"张燚",
"汪之国",
"李佳佳"
],
"patent_id": "fd509ad5-7da1-464f-9b32-2858be00f2e9",
"current_assignee": [
"中国人民解放军国防科技大学"
],
"original_assignee": [
"中国人民解放军国防科技大学"
]
}
]
}
],
"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