開放都市-委員會會議記錄資料庫 API策劃

上層 開放都市計畫

討論

使用者是誰?

•  民眾、
• 空間規劃設計專業者、
• 都市計畫專業者

使用者的需求是什麼?

•  找出特定的會議紀錄
• 找出特定的人相關的會議紀錄
• 找出有爭議的都市計畫案件

輸出的內容

•  https://www.facebook.com/groups/odtwn/permalink/1854771411203935/
• whiski: 或許該去看一下國外關於會議記錄的慣例格式。例如，機關單位，應該不會是稱為 unit 吧
• 參考國外會議記錄用字，大多使用如下，可以寫在API中
• 會議記錄 minutes
• 出席的委員會成員 member in attendance // present
• 其他出席者 others in attendance // also present
• 地點 place of meeting

建置

• language: php
• framework: laravel
• GET only
• RESTful principle
  • https://kcyeu.gitbooks.io/http-api-design-guide-tc/
  • http://rettamkrad.blogspot.tw/2013/04/web-api.html
  • https://github.com/WhiteHouse/api-standards
  • POST /EFF/YOU/THIS/IS/THE/RIGHT/URL - RESTFUL API DESIGN
  • 418: I’M A TEAPOT, AND OTHER BAD API RESPONSES - RESTFUL API DESIGN
• database-end: 資料結構討論
• front-end: 前端策劃
• 參考

• 1. data.taipei
• http://data.taipei/opendata/datalist/apiAccess?scope=resourceAquire&rid=201d8ae8-dffc-4d17-ae1f-e58d8a95b162
• 2. 司法陽光網
• https://5fpro.github.io/raml-api-console/?raml=https://5fpro.github.io/jrf-sunny/api/index.raml
• https://api.jrf.org.tw/KSH/%E5%88%91%E4%BA%8B-106-%E4%B8%8A%E6%98%93-252/verdict

應有的key

• api version
• HTTP response code
• response message
• Headers

• content type: application/json

API

• /api

• msg url to api文件

• /api/minutes

• list minutes code & url (limited by 100?)
• /api/minutes/{admin}-{period}-{session}-{round}
• live example: http://commission.urbancode.tw/api/minutes/TPE-O-702-1

•     get minute information + cases code & url
•     e.g. KHH-N-10-2
•          where {admin} = KHH //高雄市
•                {period} = N //改制後
•                {session} = 10 //第10次
•                {round} = 2 //續會   
• /api/minutes/{admin}-{period}-{session}-{round}/cases/{case_code}
• live example: http://commission.urbancode.tw/api/minutes/TPE-O-702-1/cases/7vBZ0h

•     get certain case in certain minute

• /api/cases
  • /api/cases/{case_code}

•     get full progress for certain case