■レスポンスの取得方法
■APIサーバーからのレスポンス取得
コールバック関数を使用し、JSONからAPIサーバーが返す動画のメタ情報を受け取ります。
■コールバック関数書式
searchResultEq(result,p1,p2,p3)
■引数
項目名 | 必須 | 説明 | フォーマット | デフォルト値 |
result | ○ | 抽出したメタ情報のJSON文書 ※次項にて説明 |
文字列 | 無し |
p1, p2, p3 | --- | 指定の引数を戻り値としてそのまま返却 | 文字列 | 無し |
■レスポンス内容詳細
・変数resultにJSON形式(パース済み)で格納されます。
値が存在しない要素は要素自体をJSON文書に含みません。
・MIMEタイプ
application/Javascript
・文字コード
unicode(UTF-8)
・利用状況関連のresultの要素
項目名 | JSON要素 | 説明 | 備考 | |
レスポンス ステータス |
response_status | APIレスポンスステータス | ||
顧客ID | cid | 顧客ID | ||
顧客名 | company_name | 顧客名 | ||
年月 | usage | date | 指定年月 | yyyy/mm |
総容量 | volume | 各月最終日における使用総容量 | 単位:GB(小数点第2まで) | |
配信総流量 | delivery | 各月最終日における使用総流量 | 単位:GB(小数点第2まで) | |
オンデマンド 配信流量 |
ondemand_delivery | 各月最終日におけるオンデマンド配信流量 | 単位:GB(小数点第2まで) | |
ライブ 配信流量 |
live_delivery | 各月最終日におけるライブ配信流量 | 単位:GB(小数点第2まで) | |
最終更新日 | update_date | 最終更新日 | yyyy/mm/dd hh:mm:ss |
■JSONに格納されたデータの例
searchResultEq({ "response_status":"2000", "cid":"***", "company_name":"**********", "usage":[ { "date":"2014/12", "volume":"33.98", "delivery":"1083.1", "ondemand_delivery":"500", "live_delivery":"583.1", "update_date":"2014/12/31 05:30:00" }, { "date":"2014/11", "volume":"23.98", "delivery":"183.1", "ondemand_delivery":"50", "live_delivery":"133.1", "update_date":"2014/12/10 05:30:00" } ] }); |
■レスポンスステータス
ステータスCD | 説明 | 備考 |
1001 | 必須パラメータが存在しない | |
1002 | tokenが不正(base64デコード出来ない、存在しないtoken) | |
1003 | cidが不正(数値以外、存在しないcid) | |
1004 | midが不正(数値以外、存在しないmid) | |
1005 | pageNumber、pageSizeが不正(解釈出来ない、存在しないページを指定) | pageNumber、pageSizeのデフォルト値を返却 |
1006 | sortOrderが不正(解釈出来ない) | sortOrderのデフォルト値を返却 |
1007 | api_keywordsが不正(ANDとORが混在等) | |
2000 | 正常レスポンス | |
9001 | システムエラー(DB) | |
9999 | システムエラー(その他) |