{"swagger":"2.0","info":{"version":"1.1","title":"財政部財政資訊中心政府資料開放 提供 Open API Service"},"host":"eip.fia.gov.tw","basePath":"/OAI","tags":[{"name":"【資料集編號34147】非營利事業機關團體資料API","description":"Non Business Unit Controller"},{"name":"【資料集編號75136】全國各級學校統一編號資料API","description":"School Ban Data Controller"},{"name":"【資料集編號9400】全國營業(稅籍)登記資料API","description":"Business Registration Controller"}],"paths":{"/api/businessRegistration":{"get":{"tags":["【資料集編號9400】全國營業(稅籍)登記資料API"],"summary":"依分頁大小取得全國營業(稅籍)登記資料","operationId":"listAllUsingGET","produces":["*/*"],"parameters":[{"name":"limit","in":"query","description":"限制回傳資料筆數","required":true,"type":"integer","format":"int32","x-example":100},{"name":"offset","in":"query","description":"從第幾筆開始回傳,可與limit使用達到分頁目的","required":true,"type":"integer","format":"int32","x-example":0}],"responses":{"200":{"description":"查詢成功","schema":{"type":"array","items":{"$ref":"#/definitions/BusinessRegistrationBean"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/businessRegistration/{ban}":{"get":{"tags":["【資料集編號9400】全國營業(稅籍)登記資料API"],"summary":"依統一編號取得全國營業(稅籍)登記資料","operationId":"getByPkeyUsingGET","produces":["*/*"],"parameters":[{"name":"ban","in":"path","description":"統一編號","required":true,"type":"string"}],"responses":{"200":{"description":"查詢成功","schema":{"$ref":"#/definitions/BusinessRegistrationBean"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/nonBusinessUnit":{"get":{"tags":["【資料集編號34147】非營利事業機關團體資料API"],"summary":"依分頁大小統一編號取得非營利事業單位資料","operationId":"listAllUsingGET_1","produces":["*/*"],"parameters":[{"name":"limit","in":"query","description":"限制回傳資料筆數","required":true,"type":"integer","format":"int32","x-example":100},{"name":"offset","in":"query","description":"從第幾筆開始回傳,可與limit使用達到分頁目的","required":true,"type":"integer","format":"int32","x-example":0}],"responses":{"200":{"description":"查詢成功","schema":{"type":"array","items":{"$ref":"#/definitions/NonBusinessUnitBean"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/nonBusinessUnit/search":{"get":{"tags":["【資料集編號34147】非營利事業機關團體資料API"],"summary":"依查詢條件取得統一編號查詢非營利事業單位資料","operationId":"listByConditionUsingGET","produces":["*/*"],"parameters":[{"name":"ban","in":"query","description":"非營利事業單位統一編號","required":false,"type":"string"},{"name":"hsnNm","in":"query","description":"縣市名稱","required":false,"type":"string","enum":["基隆市","臺北市","新北市","桃園市","新竹市","新竹縣","苗栗縣","臺中市","彰化縣","南投縣","雲林縣","嘉義市","嘉義縣","臺南市","高雄市","屏東縣","宜蘭縣","花蓮縣","臺東縣","澎湖縣","金門縣","連江縣"]},{"name":"limit","in":"query","description":"限制回傳資料筆數","required":true,"type":"integer","format":"int32","x-example":100},{"name":"offset","in":"query","description":"從第幾筆開始回傳,可與limit使用達到分頁目的","required":true,"type":"integer","format":"int32","x-example":0}],"responses":{"200":{"description":"查詢成功","schema":{"type":"array","items":{"$ref":"#/definitions/NonBusinessUnitBean"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/nonBusinessUnit/{ban}":{"get":{"tags":["【資料集編號34147】非營利事業機關團體資料API"],"summary":"依統一編號取得非營利事業單位資料","operationId":"getByPkeyUsingGET_1","produces":["*/*"],"parameters":[{"name":"ban","in":"path","description":"非營利事業單位統一編號","required":true,"type":"string"}],"responses":{"200":{"description":"查詢成功","schema":{"$ref":"#/definitions/NonBusinessUnitBean"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/schoolBanData":{"get":{"tags":["【資料集編號75136】全國各級學校統一編號資料API"],"summary":"依分頁大小取得全國各級學校統一編號資料","operationId":"listAllUsingGET_2","produces":["*/*"],"parameters":[{"name":"limit","in":"query","description":"限制回傳資料筆數","required":true,"type":"integer","format":"int32","x-example":100},{"name":"offset","in":"query","description":"從第幾筆開始回傳,可與limit使用達到分頁目的","required":true,"type":"integer","format":"int32","x-example":0}],"responses":{"200":{"description":"查詢成功","schema":{"type":"array","items":{"$ref":"#/definitions/SchoolBanDataBean"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/schoolBanData/search":{"get":{"tags":["【資料集編號75136】全國各級學校統一編號資料API"],"summary":"依查詢條件取得各級學校統一編號資料","operationId":"listByConditionUsingGET_1","produces":["*/*"],"parameters":[{"name":"hsnNm","in":"query","description":"縣市名稱","required":false,"type":"string","allowEmptyValue":false,"enum":["基隆市","臺北市","新北市","桃園市","新竹市","新竹縣","苗栗縣","臺中市","彰化縣","南投縣","雲林縣","嘉義市","嘉義縣","臺南市","高雄市","屏東縣","宜蘭縣","花蓮縣","臺東縣","澎湖縣","金門縣","連江縣"]},{"name":"limit","in":"query","description":"限制回傳資料筆數","required":true,"type":"integer","format":"int32","x-example":100},{"name":"offset","in":"query","description":"從第幾筆開始回傳,可與limit使用達到分頁目的","required":true,"type":"integer","format":"int32","x-example":0}],"responses":{"200":{"description":"查詢成功","schema":{"type":"array","items":{"$ref":"#/definitions/SchoolBanDataBean"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}},"/api/schoolBanData/{ban}":{"get":{"tags":["【資料集編號75136】全國各級學校統一編號資料API"],"summary":"依統一編號取得全國各級學校統一編號資料","operationId":"getByPkeyUsingGET_2","produces":["*/*"],"parameters":[{"name":"ban","in":"path","description":"統一編號","required":true,"type":"string"}],"responses":{"200":{"description":"查詢成功","schema":{"$ref":"#/definitions/SchoolBanDataBean"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"查詢異常"}},"deprecated":false}}},"definitions":{"BusinessRegistrationBean":{"type":"object","required":["ban"],"properties":{"ban":{"type":"string","description":"統一編號"},"businessAddress":{"type":"string","description":"營業地址"},"headquartersBan":{"type":"string","description":"總機構統一編號"},"businessNm":{"type":"string","description":"營業人名稱"},"capitalAmount":{"type":"number","description":"資本額"},"businessSetupDate":{"type":"string","description":"設立日期"},"businessType":{"type":"string","description":"組織別名稱"},"isUseInvoice":{"type":"string","description":"使用統一發票"},"industryCd":{"type":"string","description":"行業代號"},"industryNm":{"type":"string","description":"名稱"},"industryCd1":{"type":"string","description":"行業代號1"},"industryNm1":{"type":"string","description":" 名稱1"},"industryCd2":{"type":"string","description":"行業代號2"},"industryNm2":{"type":"string","description":"名稱2"},"industryCd3":{"type":"string","description":"行業代號3"},"industryNm3":{"type":"string","description":"名稱3"}},"title":"BusinessRegistrationBean","description":"全國營業(稅籍)登記"},"NonBusinessUnitBean":{"type":"object","required":["ban"],"properties":{"ban":{"type":"string","description":"非營利事業統一編號"},"unitNm":{"type":"string","description":"非營利事業單位名稱"},"hsnNm":{"type":"string","description":"縣市名稱","enum":["基隆市","臺北市","新北市","桃園市","新竹市","新竹縣","苗栗縣","臺中市","彰化縣","南投縣","雲林縣","嘉義市","嘉義縣","臺南市","高雄市","屏東縣","宜蘭縣","花蓮縣","臺東縣","澎湖縣","金門縣","連江縣"]},"modifyDate":{"type":"string","description":"異動日期"},"modifyCd":{"type":"string","description":"異動代號"},"modifyReason":{"type":"string","description":"異動原因"}},"title":"NonBusinessUnitBean","description":"非營利事業單位"},"SchoolBanDataBean":{"type":"object","required":["ban"],"properties":{"ban":{"type":"string","description":"統一編號"},"unitNm":{"type":"string","description":"單位名稱"},"hsnNm":{"type":"string","description":"機關所在縣市"},"modifyDate":{"type":"string","description":"最近異動日期"},"modifyReasonCd":{"type":"string","description":" 最近異動原因"},"modifyReasonNm":{"type":"string","description":"原因說明文字"}},"title":"SchoolBanDataBean","description":"全國各級學校統一編號資料"}}}