カレンダー作成

    対象メンバーにカレンダーを追加します。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v1/{accountId}/calendarList

    HTTP Method

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

    Path Parameter

    パラメータ タイプ 必須 説明
    accountId String Y メンバーアカウント

    Request Body

    プロパティ タイプ 必須 説明
    name String Y カレンダー名
    description String N メモ
    invitationUserList List N カレンダーの共有情報
        email String Y 共有するメンバーアカウント
        actionType String Y アクション内容
    ● insert: 登録
        roleId Integer Y カレンダーの権限
    ● 2: カレンダーおよび予定の管理
    ● 3: 予定の管理
    ● 4: 予定詳細の閲覧
    ● 8: 予定の時間枠のみ閲覧

    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 内部エラー