レスポンス情報

レスポンスはJSON形式で全てのリクエストは以下のレスポンス情報を返します。

errors配列エラー情報
warnings配列警告情報
data配列データ情報
page1オブジェクトページ情報

エラーが起きた場合はerrors、警告の場合はwarnings、正常の場合はdataにデータ入る。 pageはデータ数が100以上の場合に必要となる。

errors

配列で1つの項目は以下のパラメータをもつ。

codeエラーコード
msgエラーメッセージ(英語のみなので多言語向けには表示が適さないかもしれない

エラー例(主なもの)

コード内容
api_downtimeダウンタイム
endpoint_deprecatedリクエストURLがすでに無効
endpoint_invalidendpoint_deprecateと基本同じ
internal_server_errorendpoint_deprecateと基本同じ
rate_limit_exceededリクエスト回数が超過(明確なリミットはない)
request_invalidパラメータなどがおかしい
{パラメータ}_requiredパラメータが足りない
{パラメータ}_invalidパラメータがおかしい

token_invalidが重要。トークンの期限が切れたときに呼ばれるのでもう一度ログインの必要がある。

ログインエラーの場合は以下のエラーが返る

  • code
    • request_invalid
  • msg
    • Invalid email or password.

warnings

省略。警告だがエラーと考えても良い。

data

データ配列。リクエストごとにことなるレスポンスをもつ。

page

配列ではなく以下のパラメータをもつ。現在のところ1ページ100項目。

currentリクエストのページ番号
totalトータルページ数
webapi/admobile_api/response_info.txt · 最終更新: 2012/06/25 02:10 (外部編集)
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0