[API] Event API

• Event API

  Event API は、イベントに関する API です。

GET /api/event/search POST /api/event/search

 イベントを検索します。

TODO: maxNum の代わりに limit でも受け付けられるようにするべき

ログイン    不要
パラメータ
    query string required
    category string required
    sortOrder string required
    offset int optional
    maxNum int optional
レスポンス
    events array[EventEx]

GET /api/event/get

イベントの詳細を取得します。

ログイン    不要
パラメータ
    eventId string required
    passcode string optional
レスポンス
    event EventEx イベント

POST /api/event/create

新しくイベントを作成します。

　　新しく作成されたイベントは下書き状態となり、publish するまで公開されません。

ログイン    必要
パラメータ
    sessionToken string required
    title string required
    beginDate DateTime required
    endDate DataTime optional
レスポンス
    eventId string コピーされたイベントのイベント ID

POST /api/event/copy

イベントをコピーして新しく作成します。自己の所有イベントでなければコピーできません。

　　新しく作成されたイベントは下書き状態となり、publish するまで公開されません。

ログイン    必要
パラメータ
    sessionToken string required
    eventId string required
レスポンス
    eventId string コピーされたイベントのイベント ID

POST /api/event/modify

イベントの内容を変更します。

ログイン    必要
パラメータ
    sessionToken string required
    eventId string required
    title string optional
    summary string optional
    category string optional
    beginDate DateTime optional
    endDate DateTime optional
    url URL optional
    place string optional
    address string optional
    description string optional
    hashTag string optional
    passcode string optional
    foreImageId ID optional
    backImageId ID optional
    relatedEventIds[] array[ID] optional
    editorIds[] array[ID] optional
レスポンス
    relatedEvents (id and title), editors (UserExクラス), eventDuration (文字列)のうち更新されたもの。
    eventDurationはbeginDateあるいはendDateが更新された際に返されます。

POST /api/event/modifyEnquete

　　イベントに付随するアンケートの内容を変更します。 　　１つ１つの項目を変更することはできず、一度に全てのアンケート項目を変更します。 　　１つ１つの項目を変更する場合、変更箇所のみを送るのではなく、すべての項目を送信する 　　必要があります。このとき、id を送り返すことによって、新しいアンケートの項目ではなく 前からあるアンケートの内容が変更された、ということを伝えることができます。

ログイン    必要
パラメータ
    eventId ID required
    sessionToken string required
    ids[] array[string] required
    questions[] array[string] required
    types[] array[string] required
    options[] array[string] required
レスポンス
    なし

POST /api/event/modifyTicket

　　イベントに付随するチケットを変更します。

ログイン    必要
パラメータ
    eventId ID required
    sessionToken string required
    id[] array[string] required
    name[] array[string] required
    applicationStart[] array[string] required
    applicationStartDayBeforeEvent[] array[int] required
    customApplicationStartDate[] array[DateTime] required
    applicationEnd[] array[string] required
    applicationEndDayBeforeEvent[] array[int] required
    customApplicationEndDate[] array[DateTime] required
    reservationEnd[] array[string] required
    reservationEndHourBefore[] array[int] required
    customReservationEndDate[] array[DateTime] required
    priceType[] array[string] required
    price[] array[int] required
    amountType[] array[string] required
    amount[] array[int] required
レスポンス
    なし

POST /api/event/publish

　　イベントを公開します。

ログイン    必要
パラメータ
    eventId ID required
    sessionToken string required
レスポンス
    なし

POST /api/event/remove

　　イベントを削除します。 　　削除されたイベントは復活できません。

ログイン    必要
パラメータ
    sessionToken string required
    eventId ID required
レスポンス
    なし

POST /api/event/sendMessage

　　参加者にメッセージを送信します。

ログイン    不要
パラメータ
    eventId string required
    subject string required
    body string required
レスポンス
    なし

POST /api/event/postComment

　　イベント上の掲示板にコメントを投稿します。

ログイン    必要
パラメータ
    sessionToken string required
    eventId ID required
    comment string required
レスポンス
    なし

POST /api/event/removeComment

　　イベント上の掲示板のコメントを削除します。

ログイン    必要
パラメータ
    sessionToken string required
    commentId ID required
レスポンス
    なし

GET /api/event/notifications

　　イベントが送信したリマインダーの状況を取得します。

ログイン    必要
パラメータ
    eventId string required
    offset int optional
    limit int optional
レスポンス
    notifications array[EventTicketNotification]