Preview schedule

POST

/schedule/preview

Request

Body Params application/json

Example

{
    "start": 0,
    "end": 0,
    "layers": [
        {
            "layer_name": "string",
            "mode": 0,
            "groups": [
                {
                    "group_name": "string",
                    "members": [
                        {
                            "role_id": 0,
                            "person_ids": [
                                0
                            ]
                        }
                    ]
                }
            ],
            "rotation_duration": 3600,
            "fair_rotation": true,
            "handoff_time": 0,
            "layer_start": 0,
            "layer_end": 0,
            "restrict_mode": 0,
            "restrict_periods": [
                {
                    "restrict_start": 0,
                    "restrict_end": 0
                }
            ],
            "day_mask": {
                "repeat": [
                    0
                ]
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/schedule/preview' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start": 0,
    "end": 0,
    "layers": [
        {
            "layer_name": "string",
            "mode": 0,
            "groups": [
                {
                    "group_name": "string",
                    "members": [
                        {
                            "role_id": 0,
                            "person_ids": [
                                0
                            ]
                        }
                    ]
                }
            ],
            "rotation_duration": 3600,
            "fair_rotation": true,
            "handoff_time": 0,
            "layer_start": 0,
            "layer_end": 0,
            "restrict_mode": 0,
            "restrict_periods": [
                {
                    "restrict_start": 0,
                    "restrict_end": 0
                }
            ],
            "day_mask": {
                "repeat": [
                    0
                ]
            }
        }
    ]
}'

Responses

🟢200成功

application/json

Body

Example

{
    "data": {
        "start": 0,
        "end": 0,
        "schedule_id": 0,
        "schedule_name": "string",
        "team_id": 0,
        "layers": [
            {
                "layer_name": "string",
                "mode": 0,
                "groups": [
                    {
                        "group_name": "string",
                        "members": [
                            {
                                "role_id": 0,
                                "person_ids": [
                                    0
                                ]
                            }
                        ]
                    }
                ],
                "rotation_duration": 3600,
                "fair_rotation": true,
                "handoff_time": 0,
                "layer_start": 0,
                "layer_end": 0,
                "restrict_mode": 0,
                "restrict_periods": [
                    {
                        "restrict_start": 0,
                        "restrict_end": 0
                    }
                ],
                "day_mask": {
                    "repeat": [
                        0
                    ]
                }
            }
        ],
        "layer_schedules": [
            {
                "layer_name": "string",
                "mode": 0,
                "schedules": [
                    {
                        "start": 0,
                        "end": 0,
                        "hash": "string",
                        "group": {
                            "group_name": "string",
                            "members": [
                                {
                                    "role_id": 0,
                                    "person_ids": [
                                        0
                                    ]
                                }
                            ]
                        }
                    }
                ]
            }
        ],
        "final_schedule": {
            "layer_name": "string",
            "mode": 0,
            "schedules": [
                {
                    "start": 0,
                    "end": 0,
                    "hash": "string",
                    "group": {
                        "group_name": "string",
                        "members": [
                            {
                                "role_id": 0,
                                "person_ids": [
                                    0
                                ]
                            }
                        ]
                    }
                }
            ]
        }
    },
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    }
}

Modified at 2025-01-22 10:14:38

Team upsert

Update schedule