|
PublicWebAPI
公開WebAPIの仕様について議論してまとめるページ
under construction. テスト運用中。書いてあるURLやJS、レスポンスなどは架空のものです。
以下のおける URL は、/ 以下を指定していますが、公式サイトの API にアクセスする場合は、http://partake.in/ を付加してください。 Accountユーザー自身に関する API セッショントークンの取得/api/account/sessionToken TBW 自分自身の情報の取得/api/account/ TBW 自分自身の参加・管理するイベントを取得/api/account/events MyPage で取得可能なイベントが見られる。 get と統合するべきか？ TBW ユーザーの設定の取得/api/account/preference get と統合するべきか？ 分けておいたほうがよいか？ TBW ユーザーの設定の変更/api/account/setPreference TBW OpenID 結びつけ状態の取得/api/account/openID get と統合するべきか？ 分けておいたほうがよいか？ TBW OpenID 結びつけ状態を解除/api/account/removeOpenID TBW カレンダー URL の取得/api/account/calendar TBW Userユーザーの取得/api/user/ TBW ユーザーが参加しているイベント情報の習得/api/user/events ユーザーページと同じ情報を得ることができる。MyPage で見られる情報とは異なる。 TBW Eventイベントの取得/api/event/ TBW とりあえずは /api/event/get でもアクセスできますが、/api/event/ の使用を推奨します。 イベントの登録/api/event/create TBW イベントの変更/api/event/modify TBW イベントの検索/api/event/search parameters
イベントへの参加、仮参加、キャンセル/api/event/enroll TBW イベント参加者の取得/api/event/participants TBW イベントのコメントの取得/api/event/comments TBW 参加者へのメッセージの送信/api/event/sendMessage TBW 参加者へのメッセージの取得/api/event/message TBW 出欠/api/event/attendance イベントへの出席、欠席を管理する用の API です。 TBW デバグ用 APIデバグ用 API は、PARTAKE が正常終了、エラー終了をどのように返すかのサンプルとして活用することができます。また、しばしばユニットテストにも利用されます。 常に 200 OK を返す/api/debug/success TBW 常に 400 Bad Request を返す/api/debug/invalid TBW 常に 404 Not found を返すTBW NoteCategoryPARTAKEが扱うイベントのカテゴリは以下のとおり。APIの引数にカテゴリを指定する場合は、大文字小文字が区別されることに注意。
SortOrderPARTAKEの検索APIに指定できるソート順は以下のとおり。APIの引数にカテゴリを指定する場合は、大文字小文字が区別されることに注意。
基本的に API のパラメータは URL の query 部分で表現される。 変更する系のメソッドは POST リクエストを、取得する系メソッドは GET リクエストを受け付ける。 返却値は全て json 形式であり、クエリーに成功すれば HTTP のステータスコードとして 200 が使われる。 失敗すれば 200 以外のエラーコードが用いられる。理由も json 形式で返される。 返却される json には、必ず result という key が含まれる。失敗すれば、reason という key で取得できる値でエラー理由が説明される。 主なエラーコードは次の通り。
URLhttp://partake.in/api/event/get?event_id=<id> Response sample{ result: "ok",
event : {
"id": "test_id",
"title": "sample event",
"summary": "a sample event to explain partake api",
"category": "neta",
"deadline": "2011/05/20 18:00:00",
"beginDate": "2011/05/20 20:00:00",
"endDate": "2011/05/20 22:00:00",
"capacity": 20,
"url": "http://partake.in/",
"place": "here",
"address": "somewhere",
"description": "<p>hogehoge</p>",
"hashTag": "#partakein",
"ownerId": "1234567890",
"managerIdList": ["1234567890a", "1234567890b"],
"isPrivate": false,
"createdAt": "2011/05/19 12:00:00",
"modifiedAt": "2011/05/19 15:00:00"
}
}if your request is rejected, partake-server response 400(Bad Request). if specified event doesn't exist, partake-server response 404(Not Found). How to access through partake.jsvar event = $.partake().event('<event_id>').get();
if (!!event) {
$('#title').text(event.title);
}TODO
| ||||||||||||||||||||||||||||||||||||||||||||||||||
► Sign in to add a comment