MySpace Open Platform

A Place For Developers

Welcome Developers!

in

Welcome!

in

REST Resource/REST リソース

Last post 01-28-2009 6:10 PM by MySpace Japan Developer Team. 0 replies.
Page 1 of 1 (1 items)
Sort Posts: Previous Next
  • 01-28-2009 6:10 PM

    REST Resource/REST リソース

    Locked Reply Contact
    原文:http://developer.myspace.com/community/RestfulAPIs/resources.aspx

    リソース

    RESTソフトウェアアーキテクチャのリソースは固有の情報ソースとして定義され、それに関連付けられたグローバル識別子URIによって参照されます。

    リ ソースの表現とは、リソースを正確に定義するパラメータが含まれたファイルのことです。たとえば、円の表現は中心点と半径で表すことができます。ネット ワーク上のクライアントとサーバーは、HTTPなどの標準インタフェースを介して通信し、リソースの表現をやり取りします。

    ア プリケーションがリソースと通信する場合は、アプリケーションはリソースの識別子(URI)、要求されたアクション(GETなど)、表現のフォーマットを 必要とします。このフォーマットは任意のタイプのコンテンツが可能ですが、HTMLまたはXMLのドキュメントであることが普通です。リソースと通信する アプリケーションには、リソースを保持しているサーバーとそのアプリケーション間のファイアウォール、ゲートウェイ、プロキシ、またはその他のネットワー クデバイスについての情報は必要ありません。

    アルバム:

    リソース: /v1/users/{userid}/albums
    説明: useridによって指定されたユーザーのアルバムを返します。
    RESTフォーマット: /v1/users/{userid}/albums
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/albums/{albumid}
    説明: useridによって指定されたユーザーの、albumidによって指定されたアルバム情報を
    取得します。
    RESTフォーマット: /v1/users/{userid}/albums/{albumid}
    リクエストメソッド: GET
    パラメータ: URI:userid、albumid

     


    アプリケーションデータ:

    リソース: /v1/users/{userid}/appdata
    説明: useridによって指定されたユーザーに割り当てられたアプリケーションデータを表す
    キー/値の組み合わせを返します。
    RESTフォーマット:  
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/appdata
    説明: useridによって指定されたユーザーのアプリケーションデータを表す
    キー/値の組み合わせを作成します。
    RESTフォーマット: /v1/users/{userid}/appdata
    リクエストメソッド: PUT
    パラメータ: URI:userid
    URLエンコード形式パラメータ。任意の個数のキー/値のペアをセミコロン(;)で
    区切って指定します。例: key1=val1&key2=val2
    レスポンス: XMLレスポンスは返信されません。

     

    リソース: /v1/users/{userid}/appdata/{keys}
    説明: セミコロン(;)で区切られた一覧パラメータkeysによって指定されたキーについて、
    useridによって指定されたユーザーに割り当てられたアプリケーションデータを表す
    キー/値の組み合わせを返します。
    RESTフォーマット: /v1/users/{userid}/appdata/{keys}
    リクエストメソッド: GET
    パラメータ: URI:userid
    keys - キーの一覧をセミコロン(;)で区切って指定します。

     

    リソース: /v1/users/{userid}/friends/appdata
    説明: useridによって指定されたユーザーのフレンドに割り当てられたアプリケーション
    データを表すキー/値の組み合わせを返します。
    RESTフォーマット: /v1/users/{userid}/friends/appdata
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/friends/appdata/{keys}
    説明: セミコロン(;)で区切られた一覧パラメータkeysによって指定されたキーについて、
    useridによって指定されたユーザーのフレンドに割り当てられたアプリケーション
    データを表すキー/値の組み合わせを返します。
    RESTフォーマット: /v1/users/{userid}/friends/appdata/{keys}
    リクエストメソッド: GET
    パラメータ: URI:userid
    keys - キーの一覧をセミコロン(;)で区切って指定します。

     


    フレンド:

    リソース: /v1/users/{userid}/friends?[list=top|online|app][&page=N][&page_size=M|all][& show=mood|status|online]
    説明: パラメータuseridによって指定されたユーザーのフレンド一覧を取得します。パラメータは
    すべて省略可能です。

    パラメータpageには1から始まる連続したpage番号を指定し、パラメータpage_sizeには
    1ページあたりのフレンド数を指定します。ここではNMに整数を指定します。
    パラメータpageを指定しないと、返されるリソース一覧は1ページ目から始まります。page_sizeを指定しないと、デフォルトで20が使用されます。
    page_sizeをallに設定すると、リクエストされた一覧内のすべてのリソースが返されます。

    パラメータlistには、以下の値のいずれか1つを指定することができます。
    top - トップフレンドを返します。online - オンラインフレンドを取得します。
    app - ユーザーのアプリケーションをインストールしたフレンドを返します。
    省略した場合は、すべてのリソースを返します。

    パラメータshowには、以下の値の任意の組み合わせを縦線(|)で区切って指定すること
    ができます。
    mood - リソースはフレンドのムードを示します。
    status - リソースはフレンドの状態を示します。
    online - リソースはフレンドのオンライン状態を示します。
    リクエストメソッド: GET
    パラメータ: URI:userid、[list]、[page]、[page_size]、[show]

     

    リソース: /v1/users/{userid}/friendslist/{friendid}show=mood|status|online]
    説明:

    ユーザー{userId}の{friendid}によって指定されたフレンドの基本情報を取得します。

    パ ラメータshowには、以下の値の任意の組み合わせを縦線(|)で区切って指定
    することができます。
    mood - リソースはフレンドのムードを示します。
    status - リソースはフレンドの状態を示します。
    online - リソースはフレンドのオンライン状態を示します。

    リクエストメソッド: GET
    パラメータ: URI:[show]

     

    リソース: /v1/users/{userid}/friendslist/{friend1; friend2; friend3â?¦.}?[show=mood|status|online]
    説明:

    セミコロン(;)で区切られたユーザー{userId}一覧によって指定されたフレンド一覧を
    取得します。

    パ ラメータshowには、以下の値の任意の組み合わせを縦線(|)で区切って指定することが
    できます。
    mood - リソースはフレンドのムードを示します。
    status - リソースはフレンドの状態を示します。
    online - リソースはフレンドのオンライン状態を示します。

    リクエストメソッド: GET
    パラメータ: URI:[show]

     


    フレンドシップ:

    リソース: /v1/users/{userid}/friends/{friendsid}
    説明: {friendsid}によって指定されたユーザーがユーザーのフレンドかどうかを示します。
    リクエストメソッド: GET
    パラメータ: URI:userid、friendsid
    friendsidは、セミコロン(;)で区切られたフレンドid一覧です。

     


    グローバル:

    リソース: /v1/appdata/global
    説明: グローバルアプリケーションデータをすべて取得します。
    RESTフォーマット: /v1/appdata/global
    リクエストメソッド: PUT
    パラメータ: URLエンコード形式パラメータ。任意の個数のキー/値のペアをセミコロン(;)で
    区切って指定します。例: key1=val1&key2=val2
    レスポンス: XMLレスポンスは返信されません。

     

    リソース: /v1/appdata/global/{keys}
    説明: 指定されたキー一覧のグローバルアプリケーションデータをすべて取得します。
    RESTフォーマット:  
    リクエストメソッド: GET
    パラメータ: URI:keys - キーの一覧をセミコロン(;)で区切って指定します。

     


    インジケータ:

    リソース: /v1/users/{userid}/indicators
    説明: useridによって指定されたユーザーのインジケータフラグを返します。
    RESTフォーマット: /v1/users/{userid}/indicators
    リクエストメソッド: GET
    パラメータ: URI:userid

     


    ムード:

    リソース: /v1/users/{userid}/mood
    説明: useridによって指定されたユーザーのムード情報を返します。
    RESTフォーマット: /v1/users/{userid}/mood
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/mood
    説明: useridによって指定されたユーザーのムードをアップロードします。
    RESTフォーマット: /v1/users/{userid}/mood
    リクエストメソッド: PUT
    パラメータ: URI:userid
    URLエンコード形式データ:mood - 整数値
    パラメータmoodで可能な値:???

     


    写真:

    リソース: /v1/users/{userid}/photos
    説明: useridによって指定されたユーザーの写真をすべて返します。
    RESTフォーマット: /v1/users/{userid}/photos
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/albums/{albumid}/photos
    説明: photoidによって指定された写真で、useridによって指定されたユーザーに属するものを
    返します。
    RESTフォーマット:  
    リクエストメソッド: GET
    パラメータ: URI:userid、photoid

     

    リソース: /v1/users/{userid}/albums/{albumid}/photos/{photoid}
    説明: albumidによって指定されたアルバムからphotoidによって指定された写真で、
    useridによって指定されたユーザーに属するものを返します。
    RESTフォーマット: /v1/users/{userid}/albums/{albumid}/photos/{photoid}
    リクエストメソッド: GET
    パラメータ: URI:userid、photoid

     


    プロフィール:

    リソース: /v1/users/{userid}/profile
    説明: パラメータuseridによって指定された特定のユーザーの完全なプロフィール情報を取得します。
    リクエストメソッド: GET
    パラメータ: URI:userid
    レスポンス: パラメータuseridによって指定されたユーザーの情報を返します。

     


    ステータス:

    リソース: /v1/users/{userid}/status
    説明: useridによって指定されたユーザーのステータス情報を返します。
    RESTフォーマット: /v1/users/{userid}/status
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/status
    説明: useridによって指定されたユーザーの状態をアップロードします。
    RESTフォーマット: /v1/users/{userid}/status
    リクエストメソッド: PUT
    パラメータ: URI:userid
    URLエンコード形式データ:状態 - テキスト値

     


    ユーザー:

    リソース: /v1/user
    説明: セッションベースの認証シナリオでユーザーについての情報を返します。
    このリクエストには、oauth_tokenパラメータとアクセストークンが含まれていなければ
    なりません。
    リクエストメソッド: GET
    パラメータ: NONE

     


    ユーザー(複数):

    リソース: /v1/users/{userid}
    説明: パラメータuseridによって指定された特定のユーザーの情報を取得します。
    リクエストメソッド: GET
    パラメータ: URI:userid
    レスポンス: パラメータuseridによって指定されたユーザーの情報を返します。

     


    ビデオ:

    リソース: /v1/users/{userid}/videos
    説明: useridによって指定されたユーザーのビデオを返します。
    RESTフォーマット: /v1/users/{userid}/videos
    リクエストメソッド: GET
    パラメータ: URI:userid

     

    リソース: /v1/users/{userid}/videos/{videoid}
    説明: videoidによって指定されたビデオで、useridによって指定されたユーザーに属するものを
    返します。
    RESTフォーマット: /v1/users/{userid}/videos/{videoid}
    リクエストメソッド: GET
    パラメータ: URI:userid、videoid
    Filed under: , , , ,
Page 1 of 1 (1 items)