| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| lgcode | required | ゴミ収集日の情報を取得する自治体のlgcodeを指定します。 利用可能なlgcodeはGET rubbish/lgcodesで取得してください。 | 18207 | |
| area | required | ゴミ収集日の情報を取得する地域名を指定します。 地域名はGET rubbish/areasで取得してください。 | 相生 | |
| callback | optinal | jsonpで取得する場合のコールバック関数名を指定します。 指定されなかった場合、JSON文字列がそのまま返されます。 | callback |
| Field | Type | Description |
|---|---|---|
| success | Boolean | 正常に取得できたかどうかを返します。trueなら正常、falseなら何らかのエラーが発生したことを示します。 |
| errors | Collection of String | エラーメッセージの配列を返します。 |
| params | Object | 取得時に適用したパラメータを保持するオブジェクトを返します。optionalなパラメータを省略した場合、デフォルトの値が入ります。 |
| result | Collection of CollectoinDay | ゴミ収集日情報の配列を返します。
Example: "result": [{
"valid": "2017-03-31",
"is_collect_to_public_holiday": false,
"patterns": [{
"description": "毎週金曜日",
"order": 0,
"day_of_week": 5
}],
"exclude_days": [
"01-01",
"01-02",
"01-03",
"01-04",
"12-29",
"12-30",
"12-31"
],
"description": "金",
"classified": "資源物",
"issued": "2016-04-01",
"include_days": ["2016-12-23"]
}] |
{
"result": [
{
"valid": "2017-03-31",
"is_collect_to_public_holiday": false,
"patterns": [{
"description": "毎週金曜日",
"order": 0,
"day_of_week": 5
}],
"exclude_days": [
"01-01",
"01-02",
"01-03",
"01-04",
"12-29",
"12-30",
"12-31"
],
"description": "金",
"classified": "資源物",
"issued": "2016-04-01",
"include_days": ["2016-12-23"]
},
{
"valid": "2017-03-31",
"is_collect_to_public_holiday": false,
"patterns": [{
"description": "毎週金曜日",
"order": 0,
"day_of_week": 5
}],
"exclude_days": [
"01-01",
"01-02",
"01-03",
"01-04",
"12-29",
"12-30",
"12-31"
],
"description": "金",
"classified": "有害物",
"issued": "2016-04-01",
"include_days": ["2016-12-23"]
},
{
"valid": "2017-03-31",
"is_collect_to_public_holiday": true,
"patterns": [
{
"description": "毎週月曜日",
"order": 0,
"day_of_week": 1
},
{
"description": "毎週木曜日",
"order": 0,
"day_of_week": 4
}
],
"exclude_days": [
"01-01",
"01-02",
"01-03",
"01-04",
"12-31"
],
"description": "月・木",
"classified": "燃やすごみ",
"issued": "2016-04-01",
"include_days": []
},
{
"valid": "2017-03-31",
"is_collect_to_public_holiday": false,
"patterns": [{
"description": "毎週金曜日",
"order": 0,
"day_of_week": 5
}],
"exclude_days": [
"01-01",
"01-02",
"01-03",
"01-04",
"12-29",
"12-30",
"12-31"
],
"description": "金",
"classified": "燃えないごみ",
"issued": "2016-04-01",
"include_days": ["2016-12-23"]
}
],
"success": true,
"params": {
"area": "相生",
"lgcode": "18207"
}
}