受け取りデータ説明（XML編） 郵便番号検索API
郵便番号検索APIの結果データ受け取り用XMLファイルのフォーマットについての説明です。
郵便番号検索APIの結果データ受け取り用XMLファイルのフォーマットについての説明です。
フォーマットは正常時とエラー時の２種類です。
文字コードはutf-8です。
要素一覧。
| 要素名 | 属性名 | 属性の値＆説明 |
|---|---|---|
| ■正常時 | ||
| ZIP_result | -- | root要素。回答全般を含みます。 |
| result | name | アプリケーション名称。 |
| result | version | アプリケーションのバージョン。 |
| result | request_url | リクエストURL。 |
| result | request_zip_num | リクエストされた郵便番号。 |
| result | request_zip_version | リクエストされた郵便番号形式。 0 = 7桁 1 = 3 or 5桁 なし = none |
| result | result_code | 結果コード 正常時 = 1 エラー時 = 0 となります。 |
| result | result_zip_num | 検索した郵便番号。 |
| result | result_zip_version | 検索した郵便番号形式。 0 = 7桁 1 = 3 or 5桁 |
| result | result_values_count | 該当した住所情報の数。 １郵便番号で２以上の町域を表す場合があり、その場合複数の住所情報を返しますので１とは限りません。 |
| ADDRESS_value | -- | 住所要素の親要素。住所情報全般を含みます。 |
| value | state_kana | 都道府県カナ。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | city_kana | 市区町村カナ。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | address_kana | 住所カナ。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | company_kana | 事業所名カナ。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | state | 都道府県。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | city | 市区町村。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | address | 住所。 ※該当情報が存在しない場合、「none」がセットされます。 |
| value | company | 事業所名。 ※該当情報が存在しない場合、「none」がセットされます。 |
| ■エラー時 | ||
| ZIP_result | -- | 正常時と同じ。 |
| result | name | 正常時と同じ。 |
| result | version | 正常時と同じ。 |
| result | request_url | 正常時と同じ。 |
| result | request_zip_num | 正常時と同じ。 |
| result | request_zip_version | 正常時と同じ。 |
| result | result_code | 結果コード 正常時 = 1 エラー時 = 0 となります。 |
| result | error_code | エラーコード。※１ |
| result | error_note | エラー内容。 |
※１エラーコード各種は以下をご覧ください。