政府資料開放跨平臺 我有話要說、我想要更多、 品質檢測、標準檢測之介接 指引 數位發展部 中華民國 113 年 5 月 目次 壹、 目的......................................................................................................................4 貳、 應用範圍..............................................................................................................5 參、 名詞定義..............................................................................................................6 肆、 跨平臺介接原則..................................................................................................8 伍、 資料交接作業......................................................................................................9 一、資料發布至政府資料開放平臺............................................................................9 二、資料交換方式......................................................................................................13 三、資料內容格式......................................................................................................13 陸、 跨平臺介接協定與功能(我有話要說)............................................................. 14 一、資料存取應用程式介面(API)功能說明.............................................................14 (一) 取得我有話要說民眾意見及機關回應(單筆)....................................................14 (二) 取得我有話要說民眾意見及機關回應(批次)....................................................16 (三) 呼叫回應/補充我有話要說................................................................................. 18 (四) 錯誤訊息代碼一覽表.......................................................................................... 23 柒、 跨平臺介接協定與功能(我想要更多)............................................................. 24 一、資料存取應用程式介面(API)功能說明.............................................................24 (一) 取得我想要更多民眾意見及機關回應.............................................................. 24 (二) 呼叫回應/補充我想要更多................................................................................. 27 (三) 退回我想要更多派送.......................................................................................... 38 (四) 錯誤訊息代碼一覽表.......................................................................................... 40 捌、 跨平臺介接協定與功能(品質檢測)................................................................. 42 一、資料存取應用程式介面(API)功能說明.............................................................42 (一) 取得機關資料集之品質檢測結果...................................................................... 42 (二) 取得單筆資料集之品質檢測結果...................................................................... 44 (三) 呼叫執行品質檢測.............................................................................................. 48 (四) 清除品質檢測暫存檔.......................................................................................... 50 (五) 重設品質檢測結果.............................................................................................. 51 (六) 錯誤訊息代碼一覽表.......................................................................................... 52 玖、 跨平臺介接協定與功能(標準檢測)................................................................. 53 一、資料存取應用程式介面(API)功能說明.............................................................53 (一) 取得機關資料集之標準檢測結果...................................................................... 53 (二) 取得單筆資料集標準檢測結果資料.................................................................. 55 (三) 呼叫執行標準檢測.............................................................................................. 58 (四) 取得特定資料集資料標準檢測欄位及URI.......................................................60 (五) 輸入特定資料集資料標準檢測欄位及URI.......................................................62 (六) 錯誤訊息代碼一覽表.......................................................................................... 64 壹、 目的 「政府資料開放跨平臺我有話要說、我想要更多、品質檢測、標準檢測之 介接指引」提供政府資料開放平臺(以下簡稱本平臺)統一依循架構和原則, 其目的冀能讓機關自建之資料開放平臺可取得本平臺與機關有關的「民眾我有 話要說、我想要更多、資料集品質檢測、資料標準檢測」等資料;機關可依循 本介接指引,將我有話要說機關回應 /補充、我想要更多機關回應 /補充內容更 新至本平臺,亦可透過介接方式執行本平臺資料集之品質檢測、資料標準檢測。 貳、 應用範圍 本說明適用於已建置之「政府資料開放平臺」,應用範圍包括: 一、 機關自建平臺可至政府資料開放平臺 (https://data.gov.tw)取得我有話要 說、我想要更多資料及資料集品質檢測、資料標準檢測結果。 二、 機關可發布我有話要說及我想要更多之回應/補充內容 三、 機關可執行批次/單筆資料集品質檢測及資料標準檢測。 參、 名詞定義 本節列出本說明中使用的名詞及其定義,提供文件閱讀參考。 表1: 名詞定義 英文名稱 中文名稱 定義 Metadata 詮釋資料 描述資料集的資料 Metadata provider 詮釋提供者/平臺 提供資料集詮釋資料之資料開放平 臺。 Publish 資料發布 由「提供者/平臺」使用「政府資料開 放平臺」的 API,主動同步 我有話要 說、品質檢測 發布至「政府資料開放 平臺」。 Service Root URL(SRU) 服務根網址 描述平臺上提供各類別應用服務之網 址。 REST 含狀態傳輸 全 名 為 Representational State Transfer,是一種軟體架構設計風格。 資源由 URI 指定,對資源的操作包括 取得、創建、修改和下架資源,這些 操 作 對 應HTTP 協 議 提 供 的 GET 、POST 、PUT 和 DELETE 方 法。 RESTFul 含狀態傳輸的 Web 服務 使用 HTTP 並遵循 REST 原則,以 URL 定位資源,根據 HTTP 內容指示 操作動作與回應訊息。 JSON format JSON 格式 JSON(JavaScript Object Notation )是 一種輕量級的資料交換語言,以文字 為基礎,且易於讓人閱讀。 API KEY 呼叫 API 使用之認 證碼 管理系統自動給予每個平臺之認證 碼,作為資料集新增、修改、下架時 的身分認證。 API KEY 採用 UUID 方 式建立,範例格式如下: 550e8400- 英文名稱 中文名稱 定義 e29b-41d4-a716-446655440000。 datasetId 資料集識別碼 「資料集詮釋資料標準指引」中所定 義之資料集識別碼,為「政府資料開 放平臺」系統自動產出 流水號,作為 識別資料集之唯一值,不得修改。 publisherOID 提供機關 物件識別 碼 識別「提供者/平臺」機關單位名稱之 唯一識別碼,物件識別碼請參考我國 物件識別碼中心網站,填寫範例請參 閱資料集詮釋資料標準指引。 commentId 我有話要說識別碼 「政府資料開放平臺」於我有話要說 功能中由系統自動產出 流水號,作為 識別我有話要說回應之 唯一值,不得 修改。 suggestId 我想要更多識別碼 「政府資料開放平臺」於我想要更多 功能中由系統自動產出 流水號,作為 識別我想要更多回應之 唯一值,不得 修改。 commentId 我想要更多民眾回 應識別碼 「政府資料開放平臺」於我想要更多 功能中由系統自動產出 流水號,作為 識別我想要更多回應之 唯一值,不得 修改。 肆、 跨平臺介接原則 跨平臺我有話要說、我想要更多、品質檢測、標準檢測之介接基本原則如 下: 「政府資料開放平臺」為政府資料交換及跨平臺介接之平臺,各機關資料 僅能 提供申請介接機關含下屬機關單位之我有話要說、我想要更多、品質檢測、標 準檢測,不得跨部會以及越級使用介接資料。 「提供者/平臺」可透過「資料發布(Publish)」方式,主動發布我有話要說、 我想要更多資料或主動要求執行品質檢測、標準檢測需求至「政府資料開放平 臺」。 「提供者/平臺」亦可透過「資料發布( Publish)」方式至「政府資料開放平 臺」取得(GET)機關的我有話要說、我想要更多、品質檢測、標準檢測結果 資料,取得我有話要說、我想要更多、品質檢測、標準檢測內容 後,可忽略、 保留部分資料欄位。 「提供者/平臺」同步於「政府資料開放平臺」時,必須包含「我有話要說、我 想要更多、品質檢測、標準檢測之介接指引」所規定資料之必填欄位,且需符 合資料格式之規定。 資料集識別碼(datasetId)、我有話要說識別碼 (commentId)及我想要更多識別 碼(suggestId)為資料交換的唯一識別碼。 伍、 資料交接作業 一、資料發布至政府資料開放平臺 我有話要說、我想要更多、品質檢測及標準檢測 集中至「政府資料開放平 臺」僅接受發布(Publish)交換模式類型。發布(Publish)類型為「提供者/平 臺」透過「政府資料開放平臺」之資料 異動 API,主動將異動(新增)之我有 話要說、我想要更多、品質檢測、標準檢測 同步至「政府資料開放平臺」。我 有話要說、我想要更多、品質檢測、標準檢測交換模式如下表說明: 表2: 政府資料開放平臺交換模式 類型 交換模式 作法說明 發布(Publish) 即時發布 「提供者/平臺」於我有話要說、我想 要更多、品質檢測、標準檢測異動時, 立即呼叫「政府資料開放平臺」之異動 我有話要說、我想要更多、品質檢測、 標準檢測API,進行異動發布。 定期發布 「提供者/平臺」定期將我有話要說、 我想要更多、品質檢測、標準檢測異動 部分,呼叫「政府資料開放平臺」之我 有話要說、我想要更多、品質檢測、標 準檢測API,進行異動發布。 以下就各交換模式進行說明,「提供者/平臺」可依據實際系統環境需求, 選擇1 種或多種交換模式將資料發布至「政府資料開放平臺」。
- 即時發布模式 「提供者/平臺」於資料異動時,立即呼叫「政府資料開放平臺」的資料異 動API,進行異動發布。「提供者/平臺」即時發布我有話要說、我想要更多、 品質檢測、標準檢測流程如下圖所示。 圖 1: 提供者/平臺即時發布我有話要說、我想要更多、品質檢測、標準檢測流程 「提供者/平臺」即時發布我有話要說、我想要更多、品質檢測、標準檢測 流程說明如下: 「提供者/平臺」管理者登入「政府資料開放平臺」系統後端管理介面申
請跨平臺介接服務,「政府資料開放平臺」管理者 審核通過後,設定其資料 發布來源IP,並提供授權API KEY。 「提供者/平臺」於資料異動後,立即執行發布異動資料。使用授權API KEY 呼叫「政府資料開放平臺」異動資料 API,進行新增(POST)於「政府 資料開放平臺」之我有話要說、 我想要更多資料、執行品質檢測、執行標準 檢測。 紀錄發布回傳結果,若有錯誤訊息,請參考錯誤處理程序,並於錯誤排 除後進行重新發布。 2. 定期發布模式 「提供者/平臺」定期檢查我有話要說、我想要更多、品質檢測、標準檢測 異動狀況,發現有異動時,呼叫政府資料開放平臺之資料 異動 API,進行異動 發布。「提供者/平臺」定期發布我有話要說、我想要更多、品質檢測、標準檢 測流程如下圖所示。 圖 2: 提供者/平臺定期發布我有話要說、我想要更多、品質檢測、標準檢測流程 「提供者/平臺」定期發布我有話要說、我想要更多、品質檢測、標準檢測 流程說明如下: (1) 「提供者/平臺」管理者登入「政府資料開放平臺」系統 後端管理介面 申請跨平臺介接服務,「政府資料開放平臺」管理者審核通過後,設定 其資料發布來源IP,並提供授權API KEY。 (2) 「提供者/平臺」設定定期發布時間,並於執行發布我有話要說、我想要更多、 品質檢測、標準檢測時。使用授權API KEY 呼叫「政府資料開放平臺」異動 資料API,進行新增(POST)於「政府資料開放平臺」之我有話要說、我想 要更多資料、執行品質檢測、執行標準檢測。 (3) 紀錄發布回傳結果,若有錯誤必須參考錯誤處理程序,並於錯誤排除後 進行重新發布。 二、資料交換方式 資料的發布方式採用 RESTFul 網路服務呼叫方式,以 HTTP POST 呼叫新 增我有話要說、我想要更多資料、執行品質檢測、執行標準檢測。 因使用 HTTP 基本認證方式, 需有授權之 API KEY ,故需採用含有 安全性傳輸的 HTTPS 方式進行資料傳輸。 取得我有話要說、我想要更多資料、品質檢測結果、標準檢測結果之呼叫 API 擷取方式必須以HTTP GET 的方式呼叫。 三、資料內容格式 資料之內容格式必須遵循「我有話要說、我想要更多、品質檢測、標準檢 測之介接指引」,資料輸出及回傳皆為JSON 格式。 陸、 跨平臺介接協定與功能(我有話要說) 一、資料存取應用程式介面(API)功能說明 針對上述功能中所提之 API 功能說明如下,SRU 代表我有話要說的 API 服 務根網址,呼叫服務路徑時,需將{SRU}代換成實際網址。 (一) 取得我有話要說民眾意見及機關回應(單筆) 透過取得我有話要說民眾意見及機關回應 API 擷取我有話要說民眾意見及 機關回應,其功能如下表所列。 表3: 取得我有話要說民眾意見及機關回應 功能說明 取得我有話要說民眾意見及機關回應 服務路徑 {SRU}/api/v2/rest/comments/{datasetId}, Method=GET 輸 入 說 明 資源路徑 {datasetId} 資源定義 資料集識別碼 輸入範例 {SRU}/api/v2/rest/comments/6564 輸入參數 無 輸 出 說 明 輸出內容 政府資料開放平臺之我有話要說民眾意見及機關回應 欄位和內容。 輸出範例 "dataset": { "datasetId": "6564", "title": "政府資料開放平臺資料集清單" }, "result": [ { "commentId": "535040", "pid": "0", "subject": "建議新增「資料集標籤」欄位內容", "comment_body_value": "管理員,您好:\r\n 不好意思 打擾了,關於此資料集的內容希望能夠新增「資料集 標籤」的欄位內容,使得可以透過標 籤查詢相關的 Open Data,再煩請評估新增,非常感謝!", "name": "Jy", "create_time": "2017-09-10 19:29:14" }, { "commentId": "537317", "pid": "0", "subject": "下載頁面出現錯誤", "comment_body_value": "管理者您好,\r\n 目前「政府 資料開放平臺資料集清單」的下 載連結似乎壞了,是 否能協助處理呢?感謝~", "name": "Jy", "create_time": "2017-09-04 15:11:52", "reply_status": "已回復" "reply": [ { "commentId": "537355", "pid": "537317", "subject": "Re:下載頁面出現錯誤", "comment_body_value": "您好,\r\n「政府資料開放平臺 資料集清單」下載連結已修復。\r\n 謝謝您對政府資料 開放之支持與關心,祝您身體健康一切如意。 國家發 展委員會 敬復", "name": "y****g", "create_time": "2017-07-07 21:32:51", } ] } ] 備註 1. 資料集識別碼(datasetId)為「政府資料開放平 臺」系統自動產出 流水號,作為識別資料集之 唯一值,不得重複與修改。 2. 我有話要說識別碼 (commentId)為「政府資料開 放平臺」系統自動產出 流水號,作為識別我有 話要說之唯一值,不得重複與修改。 3. 輸出範例的 reply 為機關首次回應、民眾首次意 見、機關對首次回應補充、機關貳次回應、民 眾貳次意見、機關對貳次回應補充之內容。 4. reply_status 欄位為回復狀態,若機關未回復, 狀態顯示「未回復」;若機關已回復,狀態顯 示「已回復」;若機關需貳次回復,狀態顯示 「再回復」。 (二) 取得我有話要說民眾意見及機關回應(批次) 透過取得我有話要說民眾意見及機關回應 API 擷取我有話要說民眾意見及 機關回應,其功能如下表所列。 表4: 取得我有話要說民眾意見及機關回應 功能說明 批次取得我有話要說民眾意見及機關回應 服務路徑 {SRU}/api/v2/rest/agency/comment, Method=GET 輸 入 說 明 資源路徑 無 資源定義 無 輸入範例 {SRU}/api/v2/rest/agency/comment 輸入參數 可輸入reply_status,包含已回復、未回復及再回復 範例: {SRU}/api/v2/rest/agency/comment?reply_status=已回復 輸 出 輸出內容 政府資料開放平臺之我有話要說民眾意見及機關回應 欄位和內容。 說 明 輸出範例 { "help": "", "success": true, "result": { "84429": { "543015": { "nid": 84429, "cid": 543015, "title": "資料無法下載", "body": "資料無法下載", "reply_status": "已回復" }, "543128": { "nid": 84429, "cid": 543128, "title": "未進行更新", "body": "未進行更新", "reply_status": "再回復" } } } } 備註 1. 資料集識別碼( nid)為「政府資料開放平臺」 系統自動產出 流水號,作為識別資料集之 唯一 值,不得重複與修改。 2. 我有話要說識別碼(cid)為「政府資料開放平臺」 系統自動產出 流水號,作為識別我有話要說之 唯一值,不得重複與修改。 3. 輸出範例的 title 及 body 為民眾 首次意見之內 容。 4. reply_status 欄位為回復狀態,若機關未回復, 狀態顯示「未回復」;若機關已回復,狀態顯 示「已回復」;若機關需貳次回復,狀態顯示 「再回復」。 (三) 呼叫回應/補充我有話要說 提供「提供者/平臺」新增「政府資料開放平臺」之我有話要說回應及補充 資料,必須配合所設定之資料來源IP 和API KEY。其功能如下表所列:
- 新增我有話要說機關回應(機關首次/貳次回應民眾) 表5: 新增我有話要說機關回應(機關首次/貳次回應民眾) 功能說明 新增我有話要說機關回應(機關首次/貳次回應民眾) 服務路徑 {SRU}/api/v2/rest/comments/{datasetId}/{commentId}, Method=POST 輸 入 說 明 資源路徑 {datasetId}/{commentId} 資源定義 資料集識別碼/我有話要說識別碼 輸入範例 {SRU}/api/v2/rest/comments/6564/537317 輸入參數 以 JSON 格式示範我有話要說回應資料 (機關首次/貳次回應 民眾)的欄位和內容: { "subject":"RE:民眾回應之標題", "comment_body_value":"RE:民眾回應之內容", "dataProvider":"loginaccount", "comment_stage":"first"(滿意度評分低於3 星,機關須貳次回 應時填入"second") } 輸 出 說 明 輸出內容 新增我有話要說回應資料之結果。 輸出範例 1. 執行成功如下所示: { "success": true, "message": "回應成功。回應 CID:537355"(系統 產生), "result": { "datasetId": "6564", "commentId": "537355", "pid": "537317", "name": "loginaccount", "created": "2017-07-07 21:32:51", "subject": " RE:民眾回應之標題", "comment_body_value": " RE:民眾回應之內容" } }
- 執行失敗如下所示: { "success": false, "error": { "datasetId": "6564", "error_type": "ER0078:comment_stage 錯誤", "message": "firstcomment_stage 填入錯誤"} } 備註 1. 資料集識別碼( datasetId)為「政府資料開放平臺」 系統自動產出流水號,作為識別資料集之唯一值,不 得重複與修改。
- 我有話要說識別碼 (commentId)為「政府資料開放平 臺」系統自動產出流水號,作為識別我有話要說之唯 一值,不得重複與修改。
- 輸入參數 dataProvider 必須填入該筆資料集的資料提 供者帳號。
- 新增我有話要說回應資料 (機關首次/貳次回應民眾)需 填入民眾我有話要說 留言之我有話要說識別碼 (commentId)。
- 輸入參數 comment_stage 內容包含 first、second,機關 針對民眾回應進行首次回應或貳次回應之區別。
- 新增我有話要說機關補充(機關首次/貳次補充回應) 表6: 新增我有話要說機關補充(機關首次/貳次補充回應) 功能說明 新增我有話要說機關補充(機關首次/貳次補充回應) 服務路徑 {SRU}/api/v2/rest/comments_ps/{datasetId}/{commentId}, Method=POST 輸 入 說 明 資源路徑 {datasetId}/{commentId} 資源定義 資料集識別碼/我有話要說識別碼 輸入範例 {SRU}/api/v2/rest/comments/6564/537355 輸入參數 以JSON 格式示範我有話要說補充資料 (機關首次/貳次補充回 應)的欄位和內容: { "subject":"補充:機關首次回應之標題", "comment_body_value":"補充:機關首次回應之內容", "dataProvider":"loginaccount", "comment_stage":"first"(機關對貳次回應 進行補充時 填 入"second") } 輸 出 說 明 輸出內容 新增我有話要說補充資料之結果。 輸 出範例
- 執行成功如下所示: { "success": true, "message": "回應成功。回應 CID:537356", "vote": "", "result": { "datasetId": "6564", "commentId": "537356", "pid": "537355", "name": " loginaccount ", "created": "2017-07-08 12:27:14", "subject": "補充:機關首次回應之標題", "comment_body_value": "補充:機關首次回應之內 容" }
- }執行失敗如下所示: { "success": false, "error": { "datasetId": "6564", "error_type": "ER0077:CID 錯誤", "message": "此CID 填入錯誤,請確認 CID 號碼與 狀態" } } 備註
- 資料集識別碼(datasetId)為「政府資料開放平臺」系 統自動產出流水號,作為識別資料集之唯一值,不得重 複與修改。
- 我有話要說識別碼 (commentId)為「政府資料開放平 臺」系統自動產出流水號,作為識別我有話要說之唯一 值,不得重複與修改。
- 輸入參數 dataProvider 必須填入該筆資料集的資料提供 者帳號。
- 新增我有話要說補充資料(機關首次/貳次補充回應)需填 入 機 關首次 / 貳 次 回 應 之 我 有 話 要 說 識 別 碼 (commentId) 。若是針對機關 首次回應 進行補充, {commentId} 填入 機 關首次 回 應 系 統 自 動 產生之 commentId ,若為針對機關貳次回應 進行補充, {commentId} 填入 機 關 貳 次 回 應 系 統 自 動 產生之 commentId。
- 輸入參數 comment_stage 內容包含 first、second,機關
針對機關首次回應之補充或貳次回應之補充區別。
(四) 錯誤訊息代碼一覽表
錯誤代碼 訊息內容 說明
ER0001 API Key 錯誤 API Key 錯誤
ER0002 來源IP 不允許 來源IP 不允許
ER0020 必填欄位未填
1.我有話要說標題(subject)未填
2.我 有 話 要 說 內 容
(comment_body_value)未填
3.資料集提供者(dataProvider)未填
4.回應次(comment_stage)未填
ER0076 資料提供者錯誤 非本資料集之資料提供者
ER0077 commentId 錯誤
此 commentId 填入 錯 誤 ,請確 認
commentId 號碼與狀態
ER0078 comment_stage 錯誤 comment_stage 填入錯誤
ER0079
民眾尚未評分或滿意度評
分大於3 星
此筆我有話要說民眾 尚未評分或滿意
度評分大於 3 星以上,無須進行貳次
回復。
柒、 跨平臺介接協定與功能(我想要更多)
一、資料存取應用程式介面(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": "民眾回復" } ] } ] } } 備註
- 我想要更多識別碼(suggestId)為「政府資料開 放平臺」系統自動產出流水號,作為我想要更 多回應之唯一值,不得重複與修改。
- reply_status 欄位為回復狀態,若機關未回復, 狀態顯示「未回復」;若機關已回復,狀態顯 示「已回復」;若機關需貳次回復,狀態顯示 「再回復」。
(二) 呼叫回應/補充我想要更多 提供「機關管理者/平臺」新增「政府資料開放平臺」之我想要更多回應及 補充資料,必須配合所設定之資料來源IP 和API KEY。而我想要更多機關之回 復類型,可分為「已開放或依申請提供」、「無法開放」、「預計開放」三種 其功能如下表所列:
- 新增我想要更多機關首次回應(已開放或依申請提供) 表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 " }
輸 出 說 明 輸出內容 政府資料開放平臺新增 我想要更多機關 首次回應(已開放或 依申請提供)資料之結果。 輸出範例
- 執行成功如下所示: { "success": true, "message": "回應成功。回應 CID:537355"(系統 產生) }
- 執行失敗如下所示: { "success": false, "error": { "error_type": null, "message": "此筆我想要更多已被貴機關回復過" } } 備註 1. 我想要更多識別碼( suggestId)為「政府資料開 放平臺」系統自動產出流水號,作為識別我想要 更多之唯一值,不得重複與修改。
- depadmin 必須填入機關管理者帳號。
- 提供機關物件識別碼( publisherOID),請參考 物件 識 別 碼 中心網 站 https://oid.nat.gov.tw/ OIDWeb/ ,為提供機關物件識別碼(OID)。
- 輸入參數 suggest_type 必須填 入回 復類型編 號,1=「已開放或依申請提供」; 2=「無法開 放」;3=「預計開放」。
- open_datasetID(開放資料集)、application_url(依申 請提供連結):可擇一填寫,或兩個都填。
- open_datasetID(開放資料集) 以陣列方式填入已開 放之資料集識別碼(datasetId),可多值。
- application_url(依申請提供連結) 以陣列方式填入 網址,最多三筆。
- suggest_contact_name( 聯 絡 人 ) 、 suggest_contact_phone( 聯 絡 人 電 話)、suggest_contact_mail(聯絡人信箱)為非必填 欄位。
- 新增我想要更多機關首次回應(無法開放) 表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 " } 輸 輸出內容 政府資料開平臺新增 我想要更多機關 首次回應資料(無法開 出 說 明 放)之結果。 輸出範例
- 執行成功如下所示: { "success": true, "message": "回應成功。回應 CID:537355"(系統 產生) }
- 執行失敗如下所示: { "success": false, "error": { "error_type": null, "message": "此筆我想要更多已被貴機關回復過" } } 備註 1. 我想要更多識別碼( suggestId)為「政府資料開 放平臺」系統自動產出流水號,作為識別我想要 更多之唯一值,不得重複與修改。
- depadmin 必須填入機關管理者帳號。
- 提供機關物件識別碼( publisherOID),請參考 物件 識 別 碼 中心網 站 https://oid.nat.gov.tw/ OIDWeb/ ,為提供機關物件識別碼(OID)。
- suggest_type 必須填入回復類型編號,1=「已開 放或依申請提供」;2=「無法開放」;3=「預計 開放」。
- notopen_reason 必須填入無法開放原因編號,選 項:1=「有資料,資料品質 限制」;2=「有資 料,法 規限制」; 3= 「無資料, 尚未蒐集建 置」;4=「無資料,需特定條件始蒐集」; 5= 「其他、研議中」。
- 若輸入參數 notopen_reason 為"3",則輸入參數 notopen_depon_legal 需填寫因哪一法條所限制。
- suggest_contact_name( 聯 絡 人 ) 、 suggest_contact_phone( 聯 絡 人 電 話)、suggest_contact_mail(聯絡人信箱)為非必填 欄位。
- 新增我想要更多機關首次回應(預計開放) 表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"(系統 產生) }
- 執行失敗如下所示: { "success": false, "error": { "error_type": null, "message": "此筆我想要更多已被貴機關回復過" } } 備註
- 我想要更多識別碼( suggestId)為「政府資料開 放平臺」系統自動產出流水號,作為識別我想要 更多之唯一值,不得重複與修改。
- depadmin 必須填入機關管理者帳號。
- 提供機關物件識別碼( publisherOID),請參考 物件 識 別 碼 中心網 站 https://oid.nat.gov.tw/ OIDWeb/ ,為提供機關物件識別碼(OID)。
- suggest_type 必須填入回復類型編號,1=「已開 放或依申請提供」;2=「無法開放」;3=「預計 開放」。
- expected_time( 預計開放 日期) 格式 須為 YYYY- MM-DD,且日期須填當日+3,以及3 年內。
- suggest_contact_name( 聯 絡 人 ) 、 suggest_contact_phone( 聯 絡 人 電 話)、suggest_contact_mail(聯絡人信箱)為非必填 欄位。
- 機關新增「預計開放」資料之後續回復 表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 " } 輸 出 說 明 輸出內容 機關新增「預計開放」資料之後續回復。 輸出範例
- 執行成功如下所示: { "success": true, "message": "回復成功。我想要更多ID:86106" }
- 執行失敗如下所示:
{
"success": false,
"error": {
"error_type": null, "message": "回復失敗。此資料集非預計開放或已 填寫過後續回復" } } 備註
我想要更多識別碼(suggestId)為「政府資料開放