臺中市政府陳情整合平台

進階搜尋

福利補助陳情

小中大

:::

首頁 > 1999臺中市民一碼通 > Open Api

使用說明

Open API 可以讓開發人員使用介接的方式，提供派工通報資料或取得通報資料，主要的方法如下:

1、新增派工案件通報

2、查詢單筆或多筆派工案件的狀態及內容

3、查詢派工案件類別及說明

API 是依據 Open311 GeoReport v2

( http://wiki.open311.org/GeoReport_v2/ ) 所建立的國際通用標準規格來做為設計的規範。

一、新增服務案件 ( POST Service Request )

1.提供新增派工通報案件資料。

URL: https://<server_ip>/PostRequest.[format]
範例URL: https://talk.taichung.gov.tw/openAPI/PostRequest.json
傳送編碼: Content-Type application/x-www-form-urlencoded or multipart/form-data ; charset=utf-8
資料格式: XML,JSON
HTTP Method: POST
是否需要API KEY: 是

2.傳入參數

參數名稱 Field Name	說明 Description	是否為必填 Required	備註 Notes
api_key	API KEY	是	需申請取得
jurisdiction_id	城市識別代碼	是	taichung.gov.tw
service_code	案件類型識別碼	是
description	案件內容描述	是	至少10個字，至多4000個字
address_string	發生地點	是	案件發生地點的詳細地址
lat	緯度(WGS84)	否	發生地點的緯度
long	經度(WGS84)	否	發生地點的經度
name	陳情人姓名	是
phone	陳情人電話	否
email	陳情人電子郵件	是
account_id	陳情人登錄帳號	否
device_id	設備ID	否	只用於行動裝置。 Android可使用 TelephonyManager.getDeviceId() 方法取得 iPhones可使用[UIDevice currentDevice].uniqueIdentifier 方法取得
media_url	附加檔URL	否	可取得附加檔的URL，如照片檔

3.輸出參數

參數名稱 Field Name	參數說明 Description	備註 Notes
service_request_id	案件編號	唯一值不可重覆
service_notice	案件處理說明

4.可能回傳的錯誤訊息：

403 - 無效的 API KEY
404 - service_code 或jurisdiction_id 不存在
400 - service_code 或jurisdiction_id 未輸入
400 - 一般網路服務錯誤，於處理過程中產生的各種可能問題。

5.輸出範例

JSON	XML
[ { "service_request_id":293944, "service_notice":"預計處理天數 3 個工作天" } ]	<?xml version="1.0" encoding="utf-8" ?> <service_requests> <request> <service_request_id>293944</service_request_id> <service_notice> 預計處理天數 3 個工作天 </service_notice> </request> </service_requests>

JSON

XML

[
  {
    "service_request_id":293944,
    "service_notice":"預計處理天數 3 個工作天"
  }
]

<?xml version="1.0" encoding="utf-8" ?>
<service_requests>
  <request>
    <service_request_id>293944</service_request_id>
    <service_notice>
      預計處理天數 3 個工作天
    </service_notice>
  </request>
</service_requests>

二、服務案件批次查詢(GET Service Requests)

1.提供批次查詢案件的內容及處理狀況

URL: https://<server_ip>/requests.[format]
範例URL: https://talk.taichung.gov.tw/openAPI/requests.json?jurisdiction_id=taichung.gov.tw& start_date=2010-05-24T00:00:00Z&end_date=2010-06-24T00:00:00Z&status=open
資料格式: XML,JSON
HTTP Method: GET
是否需要API Key: 是

2.傳入參數

參數名稱 Field Name	說明 Description	是否為必填 Required	備註 Notes
api_key	API KEY	是	需申請取得
jurisdiction_id	城市識別代碼	是	taichung.gov.tw
service_request_id	案件編號	否	1.多筆案件需用逗號分隔 2.如果有輸入此欄位值，則忽略其它欄位值
service_code	案件類型識別碼	否	1.如果沒有輸入，預設全部型的案件 2.多筆類型需用逗號分隔
start_date	案件通報時間起時	否	如果沒有輸入，預設範圍為90天格式：2010-01-01T00:00:00Z
end_date	案件通報時間迄時	否	如果沒有輸入，預設範圍為90天格式：2010-01-01T00:00:00Z
status	案件狀態	否	1.如果沒有輸入，預設全部狀態的案件 2.待分派、待辦中、已處理

3.輸出參數

參數名稱 Field Name	參數說明 Description	備註 Notes
service_request_id	案件編號	唯一值不可重覆
status	案件狀態	待分派、待辦中、已處理
status_notes	案件狀態說明	詳細說明案件的處理內容
service_code	案件類型識別碼	唯一值不可重覆
service_name	案件類型名稱
description	案件內容描述
address_string	發生地點	案件發生地點的詳細地址
lat	緯度(WGS84)	發生地點的緯度
long	經度(WGS84)	發生地點的經度
media_url	附加檔URL	可取得附加檔的URL，如照片檔
agency_responsible	承辨單位	處理案件的承辨單位或機構
service_notice	案件處理說明	定義案件的處理資訊，例如：工務局將在4小時內先設置安全維護措施，並於 4 日內修復
requested_datetime	案件通報時間	格式：2010-01-01T00:00:00Z
updated_datetime	案件最後異動時間	格式：2010-01-01T00:00:00Z
expected_datetime	案件預計完成時間	格式：2010-01-01T00:00:00Z

4.可能回傳的錯誤訊息：

404 - jurisdiction_id 不存在
400 - jurisdiction_id 未輸入
400 - 一般網路服務錯誤，於處理過程中產生的各種可能問題。

5.輸出範例

JSON	XML
[ { "service_request_id":638344, "status":"closed", "status_notes":"Duplicate request.", "service_name":"Sidewalk and Curb Issues", "service_code":006, "description":"CC", "agency_responsible":"AA", "service_notice":"BB", "requested_datetime":"2010-04-14T06:37:38", "updated_datetime":"2010-04-14T06:37:38", "expected_datetime":"2010-04-15T06:37:38", "address":"8TH AVE and JUDAH ST", "lat":37.762221815, "long":-122.4651145, "media_url":"http://amazonaws.com/requests/media/638344.jpg" } ]	<?xml version="1.0" encoding="utf-8"?> <service_requests> <request> <service_request_id>638344</service_request_id> <status>closed</status> <status_notes>Duplicate request.</status_notes> <service_name>Sidewalk and Curb Issues</service_name> <service_code>006</service_code> <description>CC</description> <agency_responsible>AA</agency_responsible> <service_notice>BB</service_notice> <requested_datetime>2010-04-14T06:37:38</requested_datetime> <updated_datetime>2010-04-14T06:37:38</updated_datetime> <expected_datetime>2010-04-15T06:37:38 </expected_datetime> <address>8TH AVE and JUDAH ST </address> <lat>37.762221815</lat> <long>-122.4651145</long> <media_url>http://amazonaws.com/requests/media/638344.jpg </media_url> </request> </service_requests>

JSON

XML

[
  {
    "service_request_id":638344,
    "status":"closed",
    "status_notes":"Duplicate request.",
    "service_name":"Sidewalk and Curb Issues",
    "service_code":006,
    "description":"CC",
    "agency_responsible":"AA",
    "service_notice":"BB",
    "requested_datetime":"2010-04-14T06:37:38",
    "updated_datetime":"2010-04-14T06:37:38",
    "expected_datetime":"2010-04-15T06:37:38",
    "address":"8TH AVE and JUDAH ST",
    "lat":37.762221815,
    "long":-122.4651145,
    "media_url":"http://amazonaws.com/requests/media/638344.jpg"
  }
]

<?xml version="1.0" encoding="utf-8"?>
<service_requests>
<request>
<service_request_id>638344</service_request_id>
<status>closed</status>
<status_notes>Duplicate request.</status_notes>
<service_name>Sidewalk and Curb Issues</service_name>
<service_code>006</service_code>
<description>CC</description>
<agency_responsible>AA</agency_responsible>
<service_notice>BB</service_notice>
<requested_datetime>2010-04-14T06:37:38</requested_datetime>
<updated_datetime>2010-04-14T06:37:38</updated_datetime>
<expected_datetime>2010-04-15T06:37:38
</expected_datetime>
<address>8TH AVE and JUDAH ST
</address>
<lat>37.762221815</lat>
<long>-122.4651145</long>
<media_url>http://amazonaws.com/requests/media/638344.jpg
</media_url>
</request>
</service_requests>

三、查詢單一服務案件(GET Service Request)

1.提供依案件編號查詢單一案件的內容及處理狀況。

URL: https://<server_ip >/requests/[service_request_id].[format]
範例URL: https://talk.taichung.gov.tw/openAPI/requests/123456.json?jurisdiction_id=taichung.gov.tw
資料格式: XML,JSON
HTTP Method: GET
是否需要API Key: 是

2.傳入參數

參數名稱 Field Name	說明 Description	是否為必填 Required	備註 Notes
api_key	API KEY	是	需申請取得
jurisdiction_id	城市識別代碼	是	taichung.gov.tw

3.輸出參數

參數名稱 Field Name	參數說明 Description	備註 Notes
service_request_id	案件編號	唯一值不可重覆
status	案件狀態	待分派、待辦中、已處理
status_notes	案件狀態說明	詳細說明案件的處理內容
service_code	案件類型識別碼	唯一值不可重覆
service_name	案件類型名稱
description	案件內容描述
address_string	發生地點	案件發生地點的詳細地址
lat	緯度(WGS84)	發生地點的緯度
long	經度(WGS84)	發生地點的經度
media_url	附加檔URL	可取得附加檔的URL，如照片檔
agency_responsible	承辨單位	處理案件的承辨單位或機構
service_notice	案件處理說明	定義案件的處理資訊，例如：工務局將在4小時內先設置安全維護措施，並於 4 日內修復
requested_datetime	案件通報時間	格式：2010-01-01T00:00:00Z
updated_datetime	案件最後異動時間	格式：2010-01-01T00:00:00Z
expected_datetime	案件預計完成時間	格式：2010-01-01T00:00:00Z

4.可能回傳的錯誤訊息：

404 - jurisdiction_id 不存在
400 - jurisdiction_id 未輸入
400 - 一般網路服務錯誤，於處理過程中產生的各種可能問題。

5.輸出範例

JSON	XML
[ { "service_request_id":638344, "status":"closed", "status_notes":"Duplicate request.", "service_name":"Sidewalk and Curb Issues", "service_code":006, "description":"CC", "agency_responsible":"AA", "service_notice":"BB", "requested_datetime":"2010-04-14T06:37:38-08:00", "updated_datetime":"2010-04-14T06:37:38-08:00", "expected_datetime":"2010-04-15T06:37:38-08:00", "address":"8TH AVE and JUDAH ST", "lat":37.762221815, "long":-122.4651145, "media_url":"http://amazonaws.com/requests/media/638344.jpg" } ]	<?xml version="1.0" encoding="utf-8"?> <service_requests> <request> <service_request_id>638344</service_request_id> <status>closed</status> <status_notes>Duplicate request.</status_notes> <service_name>Sidewalk and Curb Issues</service_name> <service_code>006</service_code> <description>CC</description> <agency_responsible>AA</agency_responsible> <service_notice>BB</service_notice> <requested_datetime>2010-04-14T06:37:38-08:00</requested_datetime> <updated_datetime>2010-04-14T06:37:38-08:00</updated_datetime> <expected_datetime>2010-04-15T06:37:38-08:00</expected_datetime> <address>8TH AVE and JUDAH ST</address> <lat>37.762221815</lat> <long>-122.4651145</long> <media_url>http://amazonaws.com/requests/media/638344.jpg </media_url> </request> </service_requests>

JSON

XML

[
  {
    "service_request_id":638344,
    "status":"closed",
    "status_notes":"Duplicate request.",
    "service_name":"Sidewalk and Curb Issues",
    "service_code":006,
    "description":"CC",
    "agency_responsible":"AA",
    "service_notice":"BB",
    "requested_datetime":"2010-04-14T06:37:38-08:00",
    "updated_datetime":"2010-04-14T06:37:38-08:00",
    "expected_datetime":"2010-04-15T06:37:38-08:00",
    "address":"8TH AVE and JUDAH ST",
    "lat":37.762221815,
    "long":-122.4651145,  "media_url":"http://amazonaws.com/requests/media/638344.jpg"
  }
]

<?xml version="1.0" encoding="utf-8"?>
<service_requests>
<request>
<service_request_id>638344</service_request_id>
<status>closed</status>
<status_notes>Duplicate request.</status_notes>
<service_name>Sidewalk and Curb Issues</service_name>
<service_code>006</service_code>
<description>CC</description>
<agency_responsible>AA</agency_responsible>
<service_notice>BB</service_notice>
<requested_datetime>2010-04-14T06:37:38-08:00</requested_datetime>
<updated_datetime>2010-04-14T06:37:38-08:00</updated_datetime>
<expected_datetime>2010-04-15T06:37:38-08:00</expected_datetime>
<address>8TH AVE and JUDAH ST</address>
<lat>37.762221815</lat>
<long>-122.4651145</long>
<media_url>http://amazonaws.com/requests/media/638344.jpg </media_url>
</request>
</service_requests>

四、查詢服務案件類型列表(GET Service List)

1.提供可接受的服務請求類型及其關聯的服務代碼的列表。

URL: https://<server_ip>/ServiceList.[format]
範例URL: https://talk.taichung.gov.tw/openAPI/ServiceList.json?jurisdiction_id=taichung.gov.tw
資料格式: XML,JSON
HTTP Method: GET
是否需要API KEY: 否

2.傳入參數

參數名稱 Field Name	說明 Description	是否為必填 Required	備註 Notes
jurisdiction_id	城市識別代碼	是	taichung.gov.tw

3.輸出參數

參數名稱 Field Name	參數說明 Description	備註 Notes
service_code	案件類型識別碼	唯一值不可重覆
service_name	案件類型名稱
description	案件類型的簡要說明
metadata	是否有擴充欄位資料	true:是 false:否預設為false
type	資料產生方式	預設值為realtime realtime:即時產出資料 batch:需透過token才能產出資料 blackbox:不產出資料
keywords	案件類型關鍵字	多個關鍵字時，用逗號分隔。例如：案件類型為「交通號誌故障」，關鍵字可為「紅綠燈,號誌燈」
group	案件群組	為案件類型的大分類

4.可能回傳的錯誤訊息：

404 - jurisdiction_id 不存在
400 - jurisdiction_id 未輸入
400 - 一般網路服務錯誤，於處理過程中產生的各種可能問題。

5.輸出範例

JSON	XML
[ { "service_code":"S001", "service_name":"妨害安寧", "description":"如狗吠、人的噪音等", "metadata":false, "type":"realtime", "keywords":"噪音", "group":"社會安寧" }, { "service_code":"S002", "service_name":"交通號誌故障", "description":"重大路口全熄、燈號亂跳等", "metadata":false, "type":"realtime", "keywords":"紅綠燈,號誌燈", "group":"交通號誌" }, { "service_code":"S003", "service_name":"路霸排除", "description":"出入口受阻" "metadata":false, "type":"realtime", "keywords":"路霸,路障", "group":"違規處理" } ]	<?xml version="1.0" encoding="utf-8"?> <services> <service> <service_code> S001</service_code> <service_name>妨害安寧</service_name> <description>如狗吠、人的噪音等</description> <metadata>false</metadata> <type>realtime</type> <keywords>噪音</keywords> <group>社會安寧</group> </service> <service> <service_code>S002</service_code> <service_name>交通號誌故障</service_name> <description>重大路口全熄、燈號亂跳等</description> <metadata>true</metadata> <type>realtime</type> <keywords>紅綠燈,號誌燈</keywords> <group>交通號誌</group> </service> <service> <service_code>S003</service_code> <service_name>路霸排除</service_name> <description>出入口受阻</description> <metadata>true</metadata> <type>realtime</type> <keywords>路霸,路障</keywords> <group>違規處理</group> </service> </services>

JSON

XML

[
  {
    "service_code":"S001",
    "service_name":"妨害安寧",
    "description":"如狗吠、人的噪音等",
    "metadata":false,
    "type":"realtime",
    "keywords":"噪音",
    "group":"社會安寧"
  },
  {
    "service_code":"S002",
    "service_name":"交通號誌故障",
    "description":"重大路口全熄、燈號亂跳等",
"metadata":false,
    "type":"realtime",
    "keywords":"紅綠燈,號誌燈",
    "group":"交通號誌"
  },
  {
    "service_code":"S003",
"service_name":"路霸排除",
    "description":"出入口受阻"
    "metadata":false,
    "type":"realtime",
    "keywords":"路霸,路障",
    "group":"違規處理"
  }
]

<?xml version="1.0" encoding="utf-8"?>
<services>
<service>
<service_code> S001</service_code>
<service_name>妨害安寧</service_name>
<description>如狗吠、人的噪音等</description>
<metadata>false</metadata>
<type>realtime</type>
<keywords>噪音</keywords>
<group>社會安寧</group>
</service>
<service>
<service_code>S002</service_code>
<service_name>交通號誌故障</service_name>
<description>重大路口全熄、燈號亂跳等</description>
<metadata>true</metadata>
<type>realtime</type>
<keywords>紅綠燈,號誌燈</keywords>
<group>交通號誌</group>
</service>
<service>
<service_code>S003</service_code>
<service_name>路霸排除</service_name>
<description>出入口受阻</description>
<metadata>true</metadata>
<type>realtime</type>
<keywords>路霸,路障</keywords>
<group>違規處理</group>
</service>
</services>