Toy Service 共通仕様
Webサービスは,サービス単体ではほとんど使い物にはなりません.みなさまが開発されるアプリケーションの一部機能について,インターネットを介してお手伝いするものです.
応答文書の基本構造
- status
- 子要素にサービスの応答ステータスが整数で入ります.
- message
- 子要素にエラーメッセージが文字列で入ります.エラーが発生した際に1個出現します.
- result
- 子要素に結果が入ります.サービスによって子要素の構造は異なります.成功した際に1個出現します.
- argument
- 子要素に本サービスで使用された引数が入ります.サービスによって子要素の構造は異なります.成功した際に1個出現します.
- meta
- 属性に"name", "content" を持ち,子要素は持ちません.0個以上出現します.
基本応答ステータス
- 200
- 成功したことを示します.
- 400
- パラメータ等に誤りがあって失敗したことを示します.
- 500
- サーバ側で問題があって失敗したことを示します.
サービスごとの仕様
サービスごとに異なる仕様は次の通りです.
- 応答文書の基本構造のうち result の子要素はサービスごとに異なります.
- 応答文書の基本構造のうち argument の子要素はサービスごとに異なります.
- サービスごとに基本応答ステータスに追加された応答ステータスを持つことがあります.
応答タイプ
- XML
- XML形式の場合,ルート要素名はサービスごとに異なります.
- JSONP
- パラメータに"jsonp"を指定すると,JSONPまたはJSON形式になります.XMLのようなルート要素は存在しません.
- パラメータに"jsonp=(関数名)"を指定すると,JSONP形式になります.
- パラメータに"jsonp"と指定する(値を指定しない)と,JSON形式になります.
- JSON
- パラメータに"json"を指定すると,JSON形式になります.XMLのようなルート要素は存在しません.jsonの値は指定してもしなくても変わりありません.
- PHP
- パラメータに"php"を指定すると,PHPシリアライズ形式になります.XMLのようなルート要素は存在しません.phpの値は指定してもしなくても変わりありません.

