カレンダー作成

    ログインしたユーザーアカウントにカレンダーを作成します。

    APIの種類

    サービスAPI

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v2/users/me/calendarList

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Request Body

    プロパティ タイプ 必須 説明
    name String Y カレンダー名
    description String N カレンダー説明
    invitationUserList List N カレンダーを共有するメンバーリスト
        email String Y メールアドレス
        actionType String Y リクエストタイプ
    ● insert: 登録
        roleId Integer Y 権限タイプ
    ● 2: 管理者(staff)。サービス画面上ではカレンダーおよび予定の管理と表示されます。
    ● 3: 正会員(member)。サービス画面上では予定の管理と表示されます。
    ● 4: 会員(half_member)。サービス画面上では予定の詳細を閲覧と表示されます。
    ● 8: 時間閲覧委任(timelookup_only_delegater)。サービス画面上では予定の時間枠のみ閲覧と表示されます。

    Request Example

    {
    "invitationUserList": [
        {
            "email": "user01@example.com",
            "actionType": "insert",
            "roleId": 2
        }
    ],
    "name": "Calendar name",
    "description": "Calendar description"
}

    Response

    プロパティ タイプ 必須 説明
    result String Y API呼び出し結果
    code Integer Y HTTPステータスコード
    returnValue String Y カレンダーID

    Response Example

    {
    "result": "success",
    "code": 200,
    "returnValue": "b6e780ec-4779-4027-8219-a0dfeb2841f5"
}

    Error Code

    HTTPステータス エラーコード 説明
    400 BAD_REQUEST 不正なリクエスト
    403 FORBIDDEN 権限のないリソースへのアクセス
    404 NOT_FOUND 対象リソースがない
    500 INTERNAL_SERVER_ERROR 内部エラー