メインコンテンツまでスキップ
バージョン: v1

PATCH

PATCH /v1/school​

警告

認証が必須です。

危険

廃止の一歩を踏み出しています。

このエンドポイントは非推奨とマークされてます。

危険

非推奨です。

非推奨のエンドポイントです。

学校情報を更新します。

これには

  • 時間割
  • 標準時間割
  • イベントデータ 等々

が含まれます。

Request​

PATCH /v1/school

Request Body​

headkey : details​

{
    schoolId : "学校IDです。",
    bodies : [
        {
            headkey : "details",
            //
            // detailsの場合に必要なデータです。
            // 今のところ、権限がオーナーの場合に変更ができます。
            // それ以外のユーザーが変更しようとすると403が返ります。
            // また、idは変更できません。
            //
            key : "type" | "name" | "ownerId" | "admins",
            //
            // detailsの時に必要なデータです。
            // detailsは headKey , key , value のみのデータで完結します。
            // これより下のデータは、userDatasの時に必要となる値です。
            //
            value : number | string | object
        }
    ]
}
値名期待される型説明
headkeyString details詳細変更頭キーです。
keyTypes "type" | "name" | "ownerId" | "admins"変更するデータの種類です。
valuenumber | string | object変更するデータです。

headkey : userDatas​

学校の時間割やイベントデータを変更する際はこちらのへっときーを使用します。

key : "timelineData" もしくは "defaultTimelineData"

{
    schoolId : "学校IDです。",
    bodies : [
        {
            headKey : "userDatas",
            key : "timelineData",
            //
            // 学年
            //
            grade : number,
            //
            // クラス
            //
            class : number,
            //
            // 変更する曜日です。
            //
            date : "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat",
            //
            // もし一部のみを変更する場合、indexを指定します。
            //
            index : number,
            //
            // indexを指定した場合は `Object`を、指定しない場合は `Array`を指定します。
            // key : "timelineData" もしくは "defaultTimelineData" の場合のデータ指定です。
            // ここではindexを指定した場合のデータを居列します。
            // indexを指定しない場合は、Arrayで指定します。
            // Arrayで指定しない場合だと、時間割データはその配列に変更されます。
            //
            value : {
                name : "教科名です。",
                place : "場所です。 nullableです。",
                homework : [
                    {
                        name : "宿題名です。",
                        // これは Boolean です。 true か false を返します。
                        istooBig : true | false,
                        page : {
                            start : "開始ページです。numberもしくはstring",
                            end : "終了ページです。 numberもしくはstring",
                            comment : "補足です。 nullableです。"
                        }
                    }
                ],
            }
        }
    ]
}
値名期待される型説明
headkeyString userDatasユーザーデータ変更頭キーです。
keyString timelineData | defaultTimelineData変更するデータの種類です。
gradenumber変更する学年です。
classnumber変更するクラスです。
dateTypes "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat"変更する曜日です。
indexnumberもし一部のみを変更する場合、indexを指定します。
valueObject | Array変更するデータです。
value.namestring教科名です。
value.placestring場所です。 nullableです。
value.homeworkArray宿題データです。
value.homework.namestring宿題名です。
value.homework.istooBigboolean宿題が大きすぎるかのフラグです。
value.homework.pageObject宿題のページデータです。
value.homework.page.startnumber | string開始ページです。
value.homework.page.endnumber | string終了ページです。
value.homework.page.commentstring補足です。 nullableです。

key : eventData

{
    schoolId : "学校IDです。",
    bodies : [
        {
            headKey : "userDatas",
            key : "timelineData",
            //
            // 学年
            //
            grade : number,
            //
            // クラス
            //
            class : number,
            //
            // 変更する曜日です。
            //
            date : "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat",
            //
            // もし一部のみを変更する場合、indexを指定します。
            //
            index : number,
            //
            // indexを指定した場合は `Object`を、指定しない場合は `Array`を指定します。
            // key : "timelineData" もしくは "defaultTimelineData" の場合のデータ指定です。
            // ここではindexを指定した場合のデータを居列します。
            // indexを指定しない場合は、Arrayで指定します。
            // Arrayで指定しない場合だと、時間割データはその配列に変更されます。
            //
            value : {
                name : "イベント名です。",
                place : "場所です。 nullableです。",
                timeData : {
                    start : "開始時間です。",
                    end : "終了時間です。",
                    isEndofDay : "終日続くイベントかのフラグです。booleanです。"
                }
            }
        }
    ]
}
値名期待される型説明
headkeyString userDatasユーザーデータ変更頭キーです。
keyString eventData変更するデータの種類です。
gradenumber変更する学年です。
classnumber変更するクラスです。
dateTypes "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat"変更する曜日です。
indexnumberもし一部のみを変更する場合、indexを指定します。
valueObject | Array変更するデータです。
value.namestringイベント名です。
value.placestring場所です。 nullableです。
value.timeDataObjectイベントの時間データです。
value.timeData.startstring開始時間です。
value.timeData.endstring終了時間です。
value.timeData.isEndofDayboolean終日続くイベントかのフラグです。

Response Datas​

権限不足​

{
    status : -1,
    body : {
        message : "Forbidden. You don't have access permission."
    }
}

エラーがある場合​

{
    status : -1,
    body : {
        message : [
            {
                message : "エラー内容です。",
                value : "期待されなかったリクエストデータの型です",
                be : "期待されるデータの型です。"
            }
        ]
    }
}

エラーがない場合​

{
    status : 0,
    body : {
        message : "Success"
    }
}