イベント情報全体を取得するための「event」と、参加者一覧のみ取得する「guests」の2つのオペレーションがあります。それぞれJSON/JSONPに対応しています。
event
イベントの名称や時間、場所、告知文面、参加者などすべての情報を取得します。
エンドンポント http://twvt.me/rsc/event GET / POST
パラメータ
| 項目 | 必須 | 説明 |
| eventname | ◯ | イベント名。取得対象イベントのURLのtwvt.me/以下の部分を指定します |
| format | JSONP形式のレスポンスとしたいとき、「jsonp」と指定します。コールバックは固定で「eventCallback」となります | |
| fixpath | コンテンツに挿入した画像のURLを、相対パスからプロトコルつき・ドメインつきの完全なURLに変換します。デフォルトでは「true」が指定されていますが、相対のままにしたい場合は「false」を指定します | |
| t | トラッキングID。ここに指定した値がページビューログに出力されます。自身でホストしたイベントのアクセス分析がしたい場合に何らかの値を指定します |
戻り値
| ErrorMessage | string | エラーメッセージ。エラーがないときは空文字列 | |
| Event | object | イベント情報 | |
| Id | string | イベントのID。イベントを一意に指定する内部管理番号 | |
| Name | string | イベント名。取得対象イベントのURLのtwvt.me/以下の部分 | |
| Title | string | 見出しタイトル | |
| Hashtag | string | ハッシュタグ | |
| HostId | string | このイベントページを作成し、編集権限のあるTwitterアカウントのユーザーID | |
| HostName | string | HostIdに対応するTwitterのユーザー名 | |
| Editors | string | 現在は未使用 | |
| Body | string | 告知本文のHTML | |
| Publish | int | 公開ステータス。0:未公開 / 1:公開 | |
| StartDate | string | イベント開催日の、午前0時ちょうどのUNIX時間。「/Date(シリアル値)/」というフォーマットのため、シリアル値を取り出して使ってください | |
| StartTime | string | イベント開始時刻。フォーマットはフリー | |
| DateDesc | string | 開催日時に関する備考 | |
| LocationName | string | イベント開催地 | |
| Address1 | string | イベント開催地の住所 | |
| Address2 | string | 住所の補足。ビル名・フロアなど | |
| LocationDesc | string | 開催地に関する備考 | |
| Guests | object | 参加表明者の一覧。フォーマットはguestsオペレーションの戻り値と同じ | |
| Capacity | int | 定員。0は定員制限なし | |
| Joinable | bool | 参加表明可否。trueは表明可 | |
| CoverImage | string | イベントのカバー画像のURL。参加表明ツイートに添付されたり、Twitterカードに表示されたり、今後拡張する機能でもイベントを代表する画像として使用します | |
| BGColor | string | PCで閲覧した際の周辺背景色RGBの16進数表現 | |
| SBColor | string | PCで閲覧した際のサイドバーの背景色RGBの16進数表現 | |
| BGImage | string | PCで閲覧した際の周辺背景の画像URL。CSSで解釈される「url( )」形式 | |
| BGRepeat | bool | 背景画像の繰り返し有無。trueで繰り返し | |
| BGScroll | bool | 背景画像のスクロール有無。trueでスクロール | |
| ErrorMessage | string | このオペレーションでは未使用 | |
| Attend | int | このオペレーションでは未使用 | |
| UpdateDate | string | 最終更新のUNIX時間。「/Date(シリアル値)/」というフォーマットのため、シリアル値を取り出して使ってください | |
リクエスト・レスポンス例
| http://twvt.me/rsc/event?eventname=apitest |
{ "ErrorMessage":"", "Event":{ "Id":"20160817155136_99667986", "Name":"apitest", "Title":"APIテスト用のイベントページ", "Hashtag":"","HostId":"99667986", "HostName":"uezochan","Editors":"", "Body":"\u003cdiv style=\"text-align: center;\"\u003eこれはAPIテスト用のページです。\u003c/div\u003e\u003cdiv style=\"text-align: center;\"\u003e↓このウサギの画像がカバーイメージになります\u003c/div\u003e\u003cdiv style=\"text-align: center;\" class=\"fullwidth\"\u003e\u003cimg src=\"http://twvt.me/rsc/eventimage/99667986_20160817160700.jpg\" class=\"snimage\"\u003e\u003cbr\u003e\u003c/div\u003e\u003cdiv style=\"text-align: center;\"\u003e\u003cbr\u003e\u003c/div\u003e\u003cdiv style=\"text-align: center;\"\u003e↓この羊の画像はカバーイメージにはなりません\u003c/div\u003e\u003cdiv style=\"text-align: center;\" class=\"fullwidth\"\u003e\u003cimg src=\"http://twvt.me/rsc/eventimage/99667986_20160817160714.jpg\" class=\"snimage\"\u003e\u003cbr\u003e\u003c/div\u003e", "Publish":1, "StartDate":"\/Date(1471824000000)\/", "StartTime":"18:00~22:00くらいまで", "DateDesc":"コスプレ先行入場17:30~", "LocationName":"twinvite開発チーム パーティールーム", "Address1":"東京都目黒区自由が丘1-1-1", "Address2":"自由が丘蕎麦協会ビル3F", "LocationDesc":"正面口を出て、ロータリーを挟んで向こう側のコーヒー屋さんの横", "Guests":{ "Yes":[{ "EventId":"20160817155136_99667986", "UserId":"99667986", "ScreenName":"uezochan", "Name":"うえぞう", "Timestamp":"\/Date(1471450161427)\/", "Attend":1, "Stealth":0 }], "Maybe":[], "No":[] }, "Capacity":0, "Joinable":true, "CoverImage":"http://twvt.me/rsc/eventimage/99667986_20160817160700.jpg", "BGColor":"#00bfff", "SBColor":"#87cefa", "BGImage":"url(http://twvt.me/rsc/eventimage/99667986_20160817155410.png)", "BGRepeat":true, "BGScroll":true, "ErrorMessage":"", "Attend":0, "UpdateDate":"\/Date(1471450189397)\/" } } |
guests
イベントの参加者一覧を取得します。参加者にはYesのみではなく、Maybe / Noを含むすべての表明が含まれます。
エンドンポント http://twvt.me/rsc/guests GET / POST
パラメータ
| 項目 | 必須 | 説明 |
| eventname | ◯ | イベント名。取得対象イベントのURLのtwvt.me/以下の部分を指定します |
| format | JSONP形式のレスポンスとしたいとき、「jsonp」と指定します。コールバックは固定で「guestsCallback」となります | |
| t | トラッキングID。ここに指定した値がページビューログに出力されます。自身でホストしたイベントのアクセス分析がしたい場合に何らかの値を指定します |
戻り値
| ErrorMessage | string | エラーメッセージ。エラーがないときは空文字列 | ||
| Guests | object | 参加表明者一覧。表明がない場合もYes・Maybe・Noの3つが返されます | ||
| Yes | object[] | Yes表明者。表明がない場合も項目数0の配列が返されます | ||
| EventId | string | イベントのID。イベントを一意に指定する内部管理番号 | ||
| UserId | string | TwitterのユーザーID。本来は数値として扱うものですが、大きいので、JavaScriptなどとの相互運用性を考慮して文字列にしています | ||
| ScreenName | string | Twitterのユーザー名 | ||
| Name | string | Twitterのユーザー名の自由な文字が使える方 | ||
| Timestamp | string | 参加表明日時のUNIX時間。「/Date(シリアル値)/」というフォーマットのため、シリアル値を取り出して使ってください | ||
| Attend | int | 参加表明の種類。1:Yes / 2:Maybe / 3:No | ||
| Stealth | int | 現在は未使用の項目 | ||
| Maybe | object[] | Maybe表明者。Yesと同じフォーマット | ||
| No | object[] | No表明者。Yesと同じフォーマット | ||
リクエスト・レスポンス例
| http://twvt.me/rsc/guests?eventname=apitest |
{ "ErrorMessage":"", "Guests":{ "Yes":[{ "EventId":"20160817155136_99667986", "UserId":"99667986", "ScreenName":"uezochan", "Name":"うえぞう", "Timestamp":"\/Date(1471450161427)\/", "Attend":1, "Stealth":0 }], "Maybe":[], "No":[] } } |