跳至主要內容

政府資料開放平臺

:::

柒、跨平臺介接協定與功能(我想要更多)

一、資料存取應用程式介面(API)功能說明

針對上述功能中所提之 API 功能說明如下，SRU 代表我有話要說的 API 服務根網址，呼叫服務路徑時，需將{SRU}代換成實際網址。

(一)取得我想要更多民眾意見及機關回應

透過取得我想要更多民眾意見及機關回應 API 擷取我想要更多民眾意見及機關回應，其功能如下表所列。

表 7: 取得我想要更多民眾意見及機關回應
功能說明 取得我想要更多民眾意見及機關回應
服務路徑 {SRU}/api/v2/rest/suggests/{suggestId}, Method=GET
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/suggests/114692
輸入參數 無
輸出說明 輸出內容 政府資料開放平臺之我想要更多民眾意見及機關回應欄位和內容。
輸出範例 {
"help": "",
"success": true,
"result":
{
"suggestId": "114692",
"title": "互助專區「我想要更多」資料",
"suggest_dataset_name": "互助專區「我想要更多」資料",
"suggest_field": "無",
"suggest_content": "1.我想要更多頁面，下方連結(CSV,JSON,XML 格式)，常常沒有資料，造成無法撈取資料\r\n 2.另外前台的上方功能項排版問題，造成無法點到輸入資料集名稱的輸入格(必須縮小視窗才可以輸入)，請一併處理",
"suggest_org": "國家發展委員會(491)",
"assign_org": "本平臺營運窗口",
"suggest_status": "已回復",
"assign_status": "已分派",
"created_time": "2020-01-21 09:28:17",
"comment": [
{
"commentId": "546728",
"pid": "0",
"subject": "本平臺營運窗口：RE：互助專區「我想要更多」資料",
"comment_body_value": "您好：\r\n\r\n 我想要更多匯出功能及搜尋功能，目前已調整完成，\r\n\r\n 造成您的不便，深感抱歉\r\n\r\n 另外，若有系統上的問題，可透過線上客服系統來反應問題。\r\n\r\n 連結如下：https://msg.data.gov.tw/\r\n\r\n 謝謝\r\n\r\n\r\n\r\n 營運團隊 敬上",
"name": "j****6",
"suggest_type": "2",
"open_datasetID": "",
"application_url": "",
"expected_time": "",
"expected_reply": "",
"notopen_reason": "無資料，尚未蒐集建置",
"notopen_depon_legal": "",
"suggest_contact_name": "",
"suggest_contact_phone": "",
"suggest_contact_mail": "",
"reply_status ": "已回復",
"status": "已結案(未開放)"
"reply": [
{
"commentId": "546729",
"pid": "546728",
"subject": "Re: 本平臺營運窗口：RE：互助專區「我想要更多」資料",
"comment_body_value": "民眾回復"
}
]
}
]
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為我想要更多回應之唯一值，不得重複與修改。
2.reply_status 欄位為回復狀態，若機關未回復，狀態顯示「未回復」；若機關已回復，狀態顯示「已回復」；若機關需貳次回復，狀態顯示「再回復」。

(二)呼叫回應/補充我想要更多

提供「機關管理者/平臺」新增「政府資料開放平臺」之我想要更多回應及補充資料，必須配合所設定之資料來源 IP 和 API KEY。而我想要更多機關之回復類型，可分為「已開放或依申請提供」、「無法開放」、「預計開放」三種其功能如下表所列：

1.新增我想要更多機關首次回應(已開放或依申請提供)

表 8: 新增我想要更多機關首次回應(已開放或依申請提供)
功能說明 新增我想要更多機關首次回應(已開放或依申請提供)
服務路徑 {SRU}/api/v2/rest/suggests/{suggestId}/first, Method=POST
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/suggests/114692/first
輸入參數 以 JSON 格式示範我想要更多機關首次回應資料(已開放或依申請提供)：
{
"publisherOID": "2.16.886.101.20003.20069",
"suggest_type": "1",
"subject": "RE:民眾回應之標題",
"open_datasetID": ["12345"],
"application_url": ["https://google.com"],
"comment_body_value": "機關首次回應之內容(已開放或依申請提供)",
"suggest_contact_name": "林先生",
"suggest_contact_phone": "0912345678",
"suggest_contact_mail": "[email protected]",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 政府資料開放平臺新增我想要更多機關首次回應(已開放或依申請提供)資料之結果。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "回應成功。回應 CID：537355"
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": null,
"message": "此筆我想要更多已被貴機關回復過"
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為識別我想要更多之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。
4.輸入參數 suggest_type 必須填入回復類型編號，1=「已開放或依申請提供」；2=「無法開放」；3=「預計開放」。
5.open_datasetID(開放資料集)、application_url(依申請提供連結)：可擇一填寫，或兩個都填。
6.open_datasetID(開放資料集) 以陣列方式填入已開放之資料集識別碼（datasetId），可多值。
7.application_url(依申請提供連結) 以陣列方式填入網址，最多三筆。
8.suggest_contact_name、suggest_contact_phone、suggest_contact_mail為非必填欄位。

2.新增我想要更多機關首次回應(無法開放)

表 9: 新增我想要更多機關首次回應(無法開放)
功能說明 新增我想要更多機關首次回應(無法開放)
服務路徑 {SRU}/api/v2/rest/suggests/{suggestId}/first, Method=POST
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/suggests/114692/first
輸入參數 以 JSON 格式示範我想要更多機關首次回應資料(無法開放)：
{
"publisherOID": "2.16.886.101.20003.20069",
"suggest_type": "2",
"subject": "RE:民眾回應之標題",
"notopen_reason": "2",
"notopen_depon_legal": "法條限制",
"comment_body_value": "機關首次回應之內容(無法開放)",
"reason":"機關詳述無法開放原因",
"suggest_contact_name": "林先生",
"suggest_contact_phone": "0912345678",
"suggest_contact_mail": "[email protected]",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 政府資料開放平臺新增我想要更多機關首次回應資料(無法開放)之結果。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "回應成功。回應 CID：537355"
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": null,
"message": "此筆我想要更多已被貴機關回復過"
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為識別我想要更多之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。
4.suggest_type 必須填入回復類型編號，1=「已開放或依申請提供」；2=「無法開放」；3=「預計開放」。
5.notopen_reason 必須填入無法開放原因編號，選項：1=「有資料，資料品質限制」；2=「有資料，法規限制」；3=「無資料，尚未蒐集建置」；4=「無資料，需特定條件始蒐集」；5=「其他、研議中」。
6.若輸入參數 notopen_reason 為"3"，則輸入參數 notopen_depon_legal 需填寫因哪一法條所限制。
7.suggest_contact_name、suggest_contact_phone、suggest_contact_mail為非必填欄位。

3.新增我想要更多機關首次回應(預計開放)

表 9：新增我想要更多機關首次回應(預計開放)
功能說明 新增我想要更多機關首次回應(預計開放)
服務路徑 {SRU}/api/v2/rest/suggests/{suggestId}/first, Method=POST
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/suggests/114692/first
輸入參數 以 JSON 格式示範我想要更多機關首次回應資料(預計開放)：
{
"publisherOID": "2.16.886.101.20003.20069",
"suggest_type": "3",
"subject": "RE:民眾回應之標題",
"comment_body_value": "機關首次回應之內容(預計開放)",
"expected_time":"2020-02-14",
"suggest_contact_name": "林先生",
"suggest_contact_phone": "0912345678",
"suggest_contact_mail": "[email protected]",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 政府資料開放平臺新增我想要更多機關首次回應(預計開放)資料之結果。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "回應成功。回應 CID：537355"
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": null,
"message": "此筆我想要更多已被貴機關回復過"
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為識別我想要更多之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。
4.suggest_type 必須填入回復類型編號，1=「已開放或依申請提供」；2=「無法開放」；3=「預計開放」。
5.expected_time(預計開放日期)格式須為 YYYY-MM-DD，且日期須填當日+3，以及 3 年內。
6.suggest_contact_name、suggest_contact_phone、suggest_contact_mail為非必填欄位。

4.機關新增「預計開放」資料之後續回復

表 10: 機關新增「預計開放」資料之後續回復
功能說明 機關新增「預計開放」資料之後續回復
服務路徑 {SRU}/api/v2/rest/expected/reply/suggests/{suggestId}, Method=POST
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/expected/reply/suggests/114692
輸入參數 以 JSON 格式示範機關新增「預計開放」資料之後續回復的欄位和內容：
{
"publisherOID": "2.16.886.101.20003.20069",
"open_datasetID": ["12345","12346"],
"expected_reply": "預計開放後續回復內容",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 機關新增「預計開放」資料之後續回復。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "回復成功。我想要更多 ID：86106"
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": null,
"message": "回復失敗。此資料集非預計開放或已填寫過後續回復"
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為識別我想要更多之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。
4.open_datasetID(開放資料集) 以陣列方式填入已開放之資料集識別碼（datasetId），可多值。

5.新增我想要更多機關貳次回應

表 11: 新增我想要更多機關貳次回應
功能說明 新增我想要更多機關貳次回應
服務路徑 {SRU}/api/v2/rest/suggests/{suggestId}/second, Method=POST
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/suggests/114692/second
輸入參數 以 JSON 格式示範新增我想要更多機關貳次回應的欄位和內容：
{
"publisherOID": "2.16.886.101.20003.20069",
"subject": "Re:民眾首次回應",
"comment_body_value": "機關針對民眾首次回應，進行貳次回應內容",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 新增我想要更多機關貳次回應之結果。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "回應成功。回應 CID：537355"(系統產生)
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": null,
"message": "此筆我想要更多已被貴機關回復過"
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為識別我想要更多之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。

6.機關針對首次/貳次回應進行補充說明

表 12: 機關針對首次/貳次回應進行補充說明
功能說明 機關針對首次/貳次回應進行補充說明
服務路徑 {SRU}/api/v2/rest/note/suggests/{commentId} Method=POST
輸入說明 資源路徑 {commentId}
資源定義 我想要更多機關首次/貳次回應之識別碼
輸入範例 {SRU}/api/v2/rest/note/suggests/543068
輸入參數 以 JSON 格式示範機關針對首次/貳次回應進行補充說明的欄位和內容：
{
"publisherOID": "2.16.886.101.20003.20069",
"subject": "補充：說明標題",
"content": "補充說明回復內容",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 機關針對首次/貳次回應進行補充說明。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "新增補充說明成功。CommentId：543235"
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": "ER0020:必填欄位未填",
"message": "必填欄位未填"
}
}
備註 1.我想要更多機關首次/貳次回應之識別碼（commentId）為「政府資料開放平臺」系統自動產出流水號，作為我想要更多首次/貳次回應之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。

(三)退回我想要更多派送

提供「機關管理者/平臺」退回「政府資料開放平臺」後臺之我想要更多派送之資料，必須配合所設定之資料來源 IP 和 API KEY。其功能如下表所列：

1.實際派發機關退回我想要更多派送

表 13: 實際派發機關退回我想要更多派送
功能說明 實際派發機關退回我想要更多派送
服務路徑 {SRU}/api/v2/rest/return/suggest/{suggestId} Method=POST
輸入說明 資源路徑 {suggestId}
資源定義 我想要更多識別碼
輸入範例 {SRU}/api/v2/rest/return/suggest/114692
輸入參數 以 JSON 格式示範退回我想要更多派送的欄位和內容：
{
"publisherOID": "2.16.886.101.20003.20069",
"return_reason": "退回原因",
"depadmin": "loginaccount"
}
輸出說明 輸出內容 實際派發機關退回我想要更多派送。
輸出範例 1.執行成功如下所示：
{
"success": true,
"message": "退回成功。"
}
2.執行失敗如下所示：
{
"success": false,
"error": {
"error_type": "ER0020:必填欄位未填",
"message": "必填欄位未填"
}
}
備註 1.我想要更多識別碼（suggestId）為「政府資料開放平臺」系統自動產出流水號，作為識別我想要更多之唯一值，不得重複與修改。
2.depadmin 必須填入機關管理者帳號。
3.提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 https://oid.nat.gov.tw/OIDWeb/ ，為提供機關物件識別碼（OID）。

(四)錯誤訊息代碼一覽表

錯誤代碼 訊息內容 說明
ER0001 API Key 錯誤 API Key 錯誤
ER0002 來源 IP 不允許 來源 IP 不允許
ER0020 必填欄位未填 1.我想要更多回復類型(suggest_type)未填
2.我想要更多回復標題(subject)未填
3.我想要更多回復內容(comment_body_value)未填
4.提供連結(application_url)或開放資料集(open_datasetID)未填或格式錯誤
5.我想要更多回復(預計開放)預計開放時間(expected_time)未填
6.我想要更多回復(無法開放)無法開放原因(notopen_reason)未填
7.無法開放原因(notopen_reason)選擇2(有資料，法規限制)時，需填寫(notopen_depon_legal)法條
8.提供機關物件識別碼(publisherOID)未填
9.機關管理者(depadmin)未填
10.機關退回我想要更多派送之退回原因(return_reason)未填
11.機關補充說明內容(content)未填
12.機關預計開放後續回復內容(expected_reply)未填
  open_datasetID 填寫錯誤 開放資料集(open_datasetID)填寫錯誤
  expected_time 填寫錯誤 預計開放時間(expected_time)格式錯誤
  notopen_reason 填寫錯誤 無法開放原因(notopen_reason)填寫錯誤
  填寫重複 此筆我想要更多已被貴機關回復過
  我想要更多回復狀態錯誤 此筆我想要更多回復狀態非「再回復」
  退回時間逾期 超過十四日期限，無法退回
  民眾尚未評分或滿意度評分大於 3 星 此筆我想要更多民眾尚未評分或滿意度評分大於 3 星以上，無須進行貳次回復