@niftyビデオ共有のAPI－共通仕様（JSON形式）　ウェブサービス：@nifty

現在位置： TOP > @niftyビデオ共有のAPI > 共通仕様（JSON形式）

共通仕様（JSON形式）

@niftyビデオ共有から提供しているJSON形式のAPIについて共通項目と、エラーについて詳しくご説明します。

要求メッセージの形式について説明します。

パラメータ	項目名	説明	必須	値	デフォルト値
alt	フォーマット	返却するデータフォーマットの種類を指定できます。・指定なし: JSON形式・json-in-script: JSONP形式・site: Nvideo形式(ラッパークラスを利用する場合の形式です)	-	文字列	-
callback	コールバック関数名	alt=json-in-scriptの場合のみ有効なパラメータでJSONP形式のコールバック関数名を指定することができます。未指定の場合には、デフォルトのコールバック関数の名前(handler)になります。	-	文字列	-

応答メッセージの共通部分の構造を以下に示します。

パラメータ	説明
status	レスポンスのステータスコード(code)、ステータスメッセージ(message)、言語情報(language)を示します。ステータスについてはステータスコードを参照してください。
result	結果をセットします。内容はAPI毎に個別に規定されているので、各APIの説明をご参照ください。

以下に応答メッセージの例を示します。

handler(
{
"status": { 
  "code": '200',
  "message": 'OK',
  "language": 'ja'
 },
"result": [ ... ]
}
);

APIの処理結果として以下の応答ステータスとメッセージを返送します。
また、HTTPの応答ステータスコードにも同じ値が設定されます。

コード	説明	メッセージ
200	成功。	OK
400	パラメータの値が不正な場合や、想定されていないパラメータなど、渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。メッセージにはエラーの原因を表示します。	（例：APIのパラメータが不正です。）
404	該当するビデオが見つからない場合、またはURLが不正で見つからない場合などに返されます。	データが見つかりません。

上記以外の共通仕様を説明します。

・日付情報には「YYYY-MM-DD hh24:mi:ss」形式を使用しています。(例:2007-06-28 06:30:39)
・要素値に数字のみの文字列が含まれる場合、数値として評価されるのを防止するため、'$$ $$'で囲んで返却する項目があります。
・要素名には英小文字のみを用います。
・要素値に真偽値が含まれる場合、真ならばtrue、偽ならばfalseを用います。
・レスポンス中の任意の要素内に出現する子要素は特に明言しない限り、そのデータの公開日時順となります。
・ご自分のユーザーIDは、@niftyビデオ共有サービスにログイン後、マイページURL中にある～/uid_*************/～の*************が該当します。
例： @niftyビデオ共有さんのマイページ「http://video.nifty.com/cs/user/video_profile/detail/uid_0000000310/1.htm」
この場合、ユーザーIDは「0000000310」になります。