Get calendar events - hokan API v2

予定一覧を取得します。

Request

Query Params

created_by_id

integer

主催者ユーザーID

optional

customer_id

integer

顧客ID

optional

guest_user_id

integer

参加者ID

optional

policy_id

integer

申込ID/契約ID

optional

ticket_id

integer

チケットID

optional

start_at

string <date-time>

開始日

optional

end_at

string <date-time>

終了日

optional

order

enum<string>

並び順

optional

Allowed values:

id-idstart_at-start_atend_at-end_atcreated_at-created_atupdated_at-updated_at

page

integer

Page

optional

>= 1

Default:

Responses

🟢200OK

application/json

Body

data

array[object (ExtEventSchema) {26}]

Data

required

integer

optional

title

string

タイトル

optional

<= 255 characters

start_at

string <date-time>

開始日時

required

end_at

string <date-time>

終了日時

required

content

string

内容

optional

Default:

place

string

場所

optional

Default:

is_all_day

boolean

終日

optional

Default:

false

remind_at

string <date-time>

リマインド通知送信日時

optional

color_code

string

カラーコード

optional

<= 64 characters

Default:

#4285F4

is_hidden

boolean

非表示

optional

Default:

false

result_is_done

boolean

完了

optional

Default:

false

result_start_at

string <date-time>

活動結果開始日時

optional

result_end_at

string <date-time>

活動結果終了日時

optional

result_content

string

活動結果内容

optional

Default:

created_at

string <date-time>

作成日時

required

updated_at

string <date-time>

更新日時

required

activity_items

array[object (ExtActivityItemOutSchema) {4}]

活動項目

optional

result_activity_item

object

活動結果項目

optional

customer_id

integer

Customer Id

optional

顧客ID

relations

array[object (ExtRelatedObjectSchema) {2}]

関連情報

optional

created_by_id

integer

主催者ユーザーID

required

guest_user_ids

array[integer]

参加ユーザーID

required

guest_group_ids

array[integer]

参加グループID

required

freq_type

enum<string>

繰り返し間隔

optional

Allowed values:

NOTHINGYEARLYMONTHLYWEEKLYDAILY

update_range

enum<string>

編集権限

optional

Allowed values:

主催者＋マネージャーと管理者誰からでも編集可能

custom_notifications

array[object (ExtCustomNotificationSchema) {2}]

通知時間設定

optional

total

integer

Total

required

Example

{
  "data": [
    {
      "id": 0,
      "title": "string",
      "start_at": "2019-08-24T14:15:22Z",
      "end_at": "2019-08-24T14:15:22Z",
      "content": "",
      "place": "",
      "is_all_day": false,
      "remind_at": "2019-08-24T14:15:22Z",
      "color_code": "#4285F4",
      "is_hidden": false,
      "result_is_done": false,
      "result_start_at": "2019-08-24T14:15:22Z",
      "result_end_at": "2019-08-24T14:15:22Z",
      "result_content": "",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "activity_items": [
        {
          "id": 0,
          "name": "string",
          "color_code": "#4285F4",
          "activity_group_id": 0
        }
      ],
      "result_activity_item": {
        "id": 0,
        "name": "string",
        "color_code": "#4285F4",
        "activity_group_id": 0
      },
      "customer_id": 0,
      "relations": [
        {
          "object_id": 0,
          "role": "string"
        }
      ],
      "created_by_id": 0,
      "guest_user_ids": [
        0
      ],
      "guest_group_ids": [
        0
      ],
      "freq_type": "NOTHING",
      "update_range": "主催者＋マネージャーと管理者",
      "custom_notifications": [
        {
          "arrival_number": 0,
          "arrival_unit": "分"
        }
      ]
    }
  ],
  "total": 0
}