# 健保論文自動化探勘API

## Article list

顯示累計確認成果。

### Request
GET http://${台大IP}/NHIRD/articlies

### Response Schema

| 欄位 | 格式 | 說明 |
| - | - | - |
| \*result | boolean | 探勘成功/失敗 |
| \*updatedDate | string | 更新日期(YYYY/MM/DD) |
| \*total | int | 總筆數 |
| - | - | - |
| \*articleId | string | 期刊論文 id |
| \*articleTitle | string | 論文標題 |
| \*authors | string | Authors|
| \*journalTitle | string | 期刊名稱|
| \*keywords | string | 關鍵字 (請用;區隔)|
| \*publicationDate | string | 發表日期(YYYY/MM) |
| \*DOI | string | 數位物件識別碼 |
| \*researchCategory | string | 研究領域(參照IF表) |
| \*IF | string | Impact Factor (參照IF表)|
| \*URL | string | URL |
| \*SSCI_SCIE | string | SSCI;SCIE(請用;區隔)(參照IF表)|
| \*issn | string | issn |
| \*eissn | string | eissn |

### Response Example

//success
{
  "result":true,
  "updatedDate" : "2022/04/09",  
  "total" : 8000,  
  "list":[
    {
        "articleId": "5f1fd8df0dac9d003b2dc327", 
        "articleTitle": "INTERNATIONAL JOURNAL FOR QUALITY IN HEALTH CARE", 
        "authors" : "Lee, LC; Yang, KP; Chen, TY",
        "keywords" : "absenteeism; intent to leave",
        "publicationDate":  "2000/10",
        "DOI": "10.1093/intqhc/12.5.413", 
        "researchCategory" : "TRANSPORTATION;ERGONOMICS",
        "IF" : "2.257",
        "URL":  "https://doi.org/10.1093/intqhc/12.5.413"
        "SSCI_SCIE": "SCIE;SSCI", 
        "issn" : "1353-4505",
        "eissn" : "" 
    }
  ]  
} 

//fail
{
  "result":false
} 

------------------------------------------------

## KeyWord

讀取關鍵字清單。

### Request
GET http://${台大IP}/NHIRD/keywords

### Response Schema

| 欄位 | 格式 | 說明 |
| - | - | - |
| \*result | boolean | 成功/失敗 |
| \*updatedDate | string | 更新日期(YYYY/MM/DD) |
| \*total | int | 總筆數 |
| - | - | - |
| \*keywords | array | 關鍵字清單 |

### Request Example

//success
{
  "result":true,
  "updatedDate" : "2022/04/09",  
  "total" : 3,  
  "keywords":[
    "LHID"
    "taiwan",
    "NHIRD"  
  ]
} 

//fail
{
  "result":false
}

------------------------------------------------

## IF 表

讀取IF對應表。

### Request
GET http://${台大IP}/NHIRD/ifTable

### Response Schema

| 欄位 | 格式 | 說明 |
| - | - | - |
| \*result | boolean | 成功/失敗 |
| \*updatedDate | string | 更新日期(YYYY/MM/DD) |
| \*total | int | 總筆數 |
| - | - | - |
| \*journalName | string | 期刊名稱 |
| \*IF | string | Impact Factor (無IF值,請空白) |
| \*SCIE_SSCI | string | SSCI;SCIE(請用;區隔) |
| \*JCRCategory | string | JCR分類(請用;區隔) |
| \*ISSN | string | ISSN |
| \*eissn | string | eissn |

### Request Example

//success
{
  "result":true,
  "updatedDate" : "2022/04/09",  
  "total" : 1100,  
  "list":[
    {
        "id": "5f1fd8df0dac9d003b2dc327", 
        "journalName": "ACCIDENT ANALYSIS AND PREVENTION",
        "IF" : "6.376",
        "SCIE_SSCI":  "SCIE;SSCI",
        "JCRCategory": "TRANSPORTATION;ERGONOMICS", 
        "issn" : "1353-4505",
        "eissn" : "1879-2057" 
    }
  ]  
} 

//fail
{
  "result":false
}

## New Article list

顯示需人工確認的期刊論文。

### Request
GET http://${台大IP}/NHIRD/newArticlies

### Response Schema

| 欄位 | 格式 | 說明 |
| - | - | - |
| \*result | boolean | 探勘成功/失敗 |
| \*updatedDate | string | 更新日期(YYYY/MM/DD) |
| \*total | int | 論文總筆數 |
| - | - | - |
| \*articleId | string | 期刊論文 id |
| \*articleTitle | string | 論文標題 |
| \*authors | string | Authors|
| \*journalTitle | string | 期刊名稱|
| \*keywords | string | 關鍵字 (請用;區隔)|
| \*publicationDate | string | 發表日期(YYYY/MM) |
| \*DOI | string | 數位物件識別碼 |
| \*researchCategory | string | 研究領域(參照IF表) |
| \*IF | string | Impact Factor (參照IF表)|
| \*URL | string | URL |
| \*SSCI_SCIE | string | SSCI;SCIE(請用;區隔)(參照IF表)|
| \*issn | string | issn |
| \*eissn | string | eissn |
| \*precision | float | AI判讀準確度（0~100）小數點1位 |

### Response Example

//success
{
  "result":true,
  "updatedDate" : "2022/04/09",  
  "total" : 8000,  
  "list":[
    {
        "articleId": "5f1fd8df0dac9d003b2dc327", 
        "articleTitle": "INTERNATIONAL JOURNAL FOR QUALITY IN HEALTH CARE", 
        "authors" : "Lee, LC; Yang, KP; Chen, TY",
        "keywords" : "absenteeism; intent to leave",
        "publicationDate":  "2000/10",
        "DOI": "10.1093/intqhc/12.5.413", 
        "researchCategory" : "TRANSPORTATION;ERGONOMICS",
        "IF" : "2.257",
        "URL":  "https://doi.org/10.1093/intqhc/12.5.413"
        "SSCI_SCIE": "SCIE;SSCI", 
        "issn" : "1353-4505",
        "eissn" : "",
        "precision": 93.5
    }
  ]  
} 

//fail
{
  "result":false
} 

------------------------------------------------

## Confirm Results

健保署回報確認成果。

### Request
PUT http://${台大IP}/NHIRD/confirmResults

### Body(*必填欄位)

| 欄位 | 格式 | 說明 |
| - | - | - |
| \*articlieId | string | 期刊論文 id |
| \*confirmResult | int | 健保期刊論文：1 / 非健保期刊論文：0 |

### Request Example

{
  "articlieId": "5f1fd8df0dac9d003b2dc327",
  "confirmResult" : 1 
}  
 

### Response Schema

| 欄位 | 格式 | 說明 |
| - | - | - |
| \*result | boolean | 成功/失敗 |
| \*articlieId | string | 期刊論文 id |
| \*confirmResult | int | 健保期刊論文：1 / 非健保期刊論文：0 |

### Response Example

//success
{
  "result":true ,  
  "articlieId": "5f1fd8df0dac9d003b2dc327",
  "confirmResult" : 1 
} 

//fail
{
  "result":false
}