API Documentation

2016/08/17(Wed) at twinvite開発ルーム
Hosted by @uezochan

Views 3402

イベント情報全体を取得するための「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。ここに指定した値がページビューログに出力されます。自身でホストしたイベントのアクセス分析がしたい場合に何らかの値を指定します

戻り値

ErrorMessagestringエラーメッセージ。エラーがないときは空文字列
Eventobjectイベント情報

IdstringイベントのID。イベントを一意に指定する内部管理番号

Namestringイベント名。取得対象イベントのURLのtwvt.me/以下の部分

Titlestring見出しタイトル

Hashtagstringハッシュタグ

HostIdstringこのイベントページを作成し、編集権限のあるTwitterアカウントのユーザーID

HostNamestringHostIdに対応するTwitterのユーザー名

Editorsstring現在は未使用

Bodystring告知本文のHTML

Publishint公開ステータス。0:未公開 / 1:公開

StartDatestringイベント開催日の、午前0時ちょうどのUNIX時間。「/Date(シリアル値)/」というフォーマットのため、シリアル値を取り出して使ってください

StartTimestringイベント開始時刻。フォーマットはフリー

DateDescstring開催日時に関する備考

LocationNamestringイベント開催地

Address1stringイベント開催地の住所

Address2string住所の補足。ビル名・フロアなど

LocationDescstring開催地に関する備考

Guestsobject参加表明者の一覧。フォーマットはguestsオペレーションの戻り値と同じ

Capacityint定員。0は定員制限なし

Joinablebool参加表明可否。trueは表明可

CoverImagestringイベントのカバー画像のURL。参加表明ツイートに添付されたり、Twitterカードに表示されたり、今後拡張する機能でもイベントを代表する画像として使用します

BGColorstringPCで閲覧した際の周辺背景色RGBの16進数表現

SBColorstringPCで閲覧した際のサイドバーの背景色RGBの16進数表現

BGImagestringPCで閲覧した際の周辺背景の画像URL。CSSで解釈される「url( )」形式

BGRepeatbool背景画像の繰り返し有無。trueで繰り返し

BGScrollbool背景画像のスクロール有無。trueでスクロール

ErrorMessagestringこのオペレーションでは未使用

Attendintこのオペレーションでは未使用

UpdateDatestring最終更新の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。ここに指定した値がページビューログに出力されます。自身でホストしたイベントのアクセス分析がしたい場合に何らかの値を指定します

戻り値

ErrorMessagestringエラーメッセージ。エラーがないときは空文字列
Guestsobject参加表明者一覧。表明がない場合もYes・Maybe・Noの3つが返されます

Yesobject[]Yes表明者。表明がない場合も項目数0の配列が返されます


EventIdstringイベントのID。イベントを一意に指定する内部管理番号


UserIdstringTwitterのユーザーID。本来は数値として扱うものですが、大きいので、JavaScriptなどとの相互運用性を考慮して文字列にしています


ScreenNamestringTwitterのユーザー名


NamestringTwitterのユーザー名の自由な文字が使える方


Timestampstring参加表明日時のUNIX時間。「/Date(シリアル値)/」というフォーマットのため、シリアル値を取り出して使ってください


Attendint参加表明の種類。1:Yes / 2:Maybe / 3:No


Stealthint現在は未使用の項目

Maybeobject[]Maybe表明者。Yesと同じフォーマット

Noobject[]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":[]

}

}




Date & Time

2016/08/17(Wed)

Location

twinvite開発ルーム

東京都目黒区



   Share this Invitation!  

Will you be attending?

  Yes     Maybe     No  

Guest List

2D Code