モジュール名: calendar

機能名 説明
list カレンダーの一覧を取得します
show カレンダーの情報を取得します
create カレンダーの情報を追加します
update カレンダーの情報を変更します
delete カレンダーの情報を削除します

機能名: list

説明

カレンダーの一覧を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/calendar/list
リクエストパラメーター

なし

リクエスト例
GET /mcapi/calendar/list HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとカレンダーの一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "calendar": [
                "calendar_1",
                "calendar_2"
            ]
        }
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5104 内部サーバーのURLが見つからなかった場合

▲ このページのトップへ

機能名: show

説明

カレンダーの情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/calendar/show
リクエストパラメーター
パラメーター 必須 説明
name はい 取得するカレンダーのカレンダー名を指定します。
year いいえ 取得するカレンダーの年(yyyy)を指定します。
指定しなかった場合すべてのカレンダー情報を取得します。

リクエスト例
GET /mcapi/calendar/show?name=calendar_1&year=2013 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとカレンダーの情報が返ります。
カレンダーの情報としては次の情報が取得できます。

{
    "calendar": {
        "2013": [
            "2013-1-1",
            "2013-2-4",
            "2013-3-8",
            "2013-12-24"
        ],
        "2014": [
            "2014-3-5",
            "2014-6-7"
        ]
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター name の値が設定されなかった場合
2003 パラメーター year の値のデータ型が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4004 パラメーター name で指定されたカレンダーの情報が存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5104 内部サーバーのURLが見つからなかった場合

▲ このページのトップへ

機能名: create

説明

カレンダーの情報を追加します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/calendar/create
リクエストパラメーター
なし

リクエスト例
カレンダー情報として次の情報を設定できます。
カレンダー名だけが必須です。
POST /mcapi/calendar/create HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 124

{
    "calendar": {
        "name": "calendar_2",
        "rule": {
            "daysOfWeek": [
                "Saturday",
                "Sunday"
            ],
            "nationalHoliday": true,
            "numberOfYears": 3,
            "locale": "ja_JP"
        },
        "list": {
            "2013": [
                "2013-1-1",
                "2013-2-4",
                "2013-3-8",
                "2013-12-24"
            ],
            "2014": [
                "2014-3-5",
                "2014-6-7"
            ]
        }
    }
}
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとカレンダー情報を作成します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2101 Jsonデータの値が正しくなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のタイプが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5104 内部サーバーのURLが見つからなかった場合

▲ このページのトップへ

機能名: update

説明

カレンダーの情報を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/calendar/update
リクエストパラメーター
パラメーター 必須 説明
name はい 変更するカレンダーのカレンダー名を指定します。

リクエスト例
年別の休日リストをリクエストのボディに設定します。
カレンダー名を変更することはできません。
POST /mcapi/calendar/update?name=calendar_1 HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 120

{
    "calendar": {
        "2013": [
            "2013-1-1",
            "2013-2-4",
            "2013-3-8",
            "2013-12-24"
        ],
        "2014": [
            "2014-3-5",
            "2014-6-7"
        ]
    }
}
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとカレンダー情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 Jsonデータの必須項目が入力されなかった場合
2103 年別の値が数字ではなかった場合
2306 日付の解析にエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4004 パラメーター name で指定されたカレンダーの情報が存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5104 内部サーバーのURLが見つからなかった場合

▲ このページのトップへ

機能名: delete

説明

カレンダーの情報を削除します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/calendar/delete
リクエストパラメーター
パラメーター 必須 説明
name はい カレンダー名を指定します。

リクエスト例
POST /mcapi/calendar/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 15

name=calendar_1
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとカレンダー情報を削除します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4004 パラメーター name で指定されたカレンダーの情報が存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5104 内部サーバーのURLが見つからなかった場合

▲ このページのトップへ