匯入API介接規範
資料擁有者可按照本平台的API介面,將議事錄資料按照指定格式上傳入本平台。
新增 單筆議事錄資料API規範
功能說明 | 輸入地方議會議事錄資料(單筆) |
---|---|
服務路徑 | POST https://ccouncil.tw/api/create/data** |
限制 | post方式需要將參數塞入body,請不要用url方式傳遞。 |
輸入參數
輸入參數 | apikey | 使用者帳號綁定之apikey(must) |
---|---|---|
originID | 該一筆議事資料在原資料來源之原始ID(must) | |
meta | 該筆議事錄資料資料(must) | |
councilNumber | 各議會對應的代碼(must)ex:高雄市議會請填'010e' | |
session | 第幾屆會議(must)ex:第二屆請填寫'002' | |
conferenceNumber | 各縣市議會內的大會名稱代碼(must)ex:第五次臨時議會請填寫'T5' |
回傳參數
回傳參數 | status | API執行成功或是失敗 |
---|---|---|
metaHash | 當API執行成功會將meta進行SHA-1編碼。並回傳讓使用者觀驗證(option) | |
timeCreated | API執行成功會顯示資料建立時間(option) | |
error_type | 當資料驗證出現錯誤,用以告知資料擁有者錯誤類型(option) | |
error_message | 表示錯誤類型的實際訊息(option) | |
originID | 表是哪一個originID錯誤(option) |
更新單筆議事錄資料API
功能說明 | 更新地方議會議事錄資料(單筆) - 只能更新自己的 |
---|---|
服務路徑 | POST {SRU}/api/update/data |
輸入參數
輸入參數 | apikey | 使用者帳號綁定之apikey(must) |
---|---|---|
originID | 要更新的資料原始編號(must) | |
meta | 要更新之單筆議事資料的全部資訊(must) | |
councilNumber | 各議會對應的代碼(must)ex:高雄市議會請填'010e' | |
session | 第幾屆會議(must)ex:第二屆請填寫'002' | |
conferenceNumber | 各縣市議會內的大會代碼(must)ex:第五次臨時議會請填寫'T5' |
輸出參數
回傳參數 | status | API執行成功或是失敗 |
---|---|---|
metaHash | 當API執行成功會將meta進行SHA-1,並回傳讓使用者觀驗證(option) | |
timeChanged | API執行成功會顯示資料異動時間(option) | |
error_type | 當驗證出現錯誤,用以告知資料擁有者錯誤類型(option) | |
error_message | 表示錯誤類型的實際訊息(option) | |
originID | 表是哪一個originID錯誤(option) |
欄位內容規範
資料擁有者匯入議事錄資料,需要注意該欄位是否為必填,且該欄位是某有規範的內容項目。若未以規範會入資料,則無法匯入議事錄資料至本平台。
欄位名稱 | 必填 | 內容限制 | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | N | ||||||||||||||||||||||||||
administrative | Y | **臺灣省\ | 台灣省\ | 臺北市\ | 台北市\ | 新北市\ | 臺中市\ | 台中市\ | 臺南市\ | 台南市\ | 高雄市\ | 桃園市\ | 基隆市\ | 新竹縣\ | 新竹市\ | 苗栗縣\ | 彰化縣\ | 雲林縣\ | 嘉義市\ | 嘉義縣\ | 宜蘭縣\ | 花蓮縣\ | 臺東縣\ | 台東縣\ | 澎湖縣\ | 金門縣\ | 連江縣** |
council | Y | 議會名稱 | |||||||||||||||||||||||||
conference | Y | 大會名稱 | |||||||||||||||||||||||||
abstract | Y | 題名摘要 | |||||||||||||||||||||||||
sourceObjectFormat | N | **GIF\ | PNG\ | JPG\ | PDF\ | DOC\ | LINK\ | DOCX\ | PPT\ | XLSX** | |||||||||||||||||
sourceObjectLink | N | ||||||||||||||||||||||||||
date | N | ||||||||||||||||||||||||||
content | N | ||||||||||||||||||||||||||
councilor | N | ||||||||||||||||||||||||||
agency | N | ||||||||||||||||||||||||||
sourceUrl | N | ||||||||||||||||||||||||||
other | N |
錯誤訊息內容查詢
欄位名稱 | 內容 | 說明 |
---|---|---|
status | success:成功。fail:錯誤。 | |
error_type | apikey:未傳入api key或不合法councilNumber:未傳入 議會代碼或不合法session:未傳入屆次格式或不合法conferenceNumber:未傳入大會次號代碼或不合法originID:未傳入originID參數或為空值meta:未傳入meta參數或為空值meta-format:meta不符合JSON格式meta-config:系統 metadata config檔來源讀取錯誤meta-necessary:meta中有必填欄位未填meta-content:meta中有欄位不符合要求內容標準record-duplicate:系統中已有此議會代碼、屆次、大會次號及originID之組合record-not-exist:此議會代碼、屆次、大會次號及originID之組合不存在(update/delete時) | 當驗證出現錯誤,用以告知資料擁有者錯誤類型。 |
error_message | The api parameter <apikey/originID/councilNumber/session/conferenceNumber> is empty.Illegalapikey/councilNumber/session/conferenceNumbermeta json decode error. json_last_error:json_last_error錯誤代碼metadata_config file source error.metadata_config decode error.<meta_column>is necessary.Illegal <meta_column>Duplicate [councilNumber/session/conferenceNumber/originID] combination.The [originID/councilNumber/session/conferenceNumber] combination does not exist. | 顯示出錯誤訊息之描述。大致錯誤分為1. empty(參數為空)2.illegal(參數不合規定)3. Json格式錯誤4.config錯誤5. 議事資料衝突6.議事資料不存在 |