Rotase

Read-only check that the Rotase scheduling service is available. Use this when connectivity or service availability is uncertain. It does not require a project and does not change data.

{
  "type": "object",
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "service": {
      "type": "string"
    },
    "phpVersion": {
      "type": "string"
    }
  }
}

Read an example store, employees and complete project payload. Defaults to English labels; pass a supported language code to localize names. Call this when the project structure or field names are unknown. The returned project can be copied and edited before validation. This operation is read-only and does not access a user browser or saved project.

{
  "type": "object",
  "properties": {
    "language": {
      "type": "string",
      "enum": [
        "bg",
        "cs",
        "da",
        "de",
        "el",
        "en",
        "es",
        "et",
        "fi",
        "fr",
        "ga",
        "hr",
        "hu",
        "it",
        "lb",
        "lt",
        "lv",
        "mt",
        "nl",
        "pl",
        "pt",
        "ro",
        "sk",
        "sl",
        "sv",
        "tr"
      ]
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array"
    },
    "project": {
      "type": "object"
    }
  }
}

Create a localized demonstration project using the same project-creation operation as the Rotase API. The server chooses the current period in the requested timezone, loads the localized demo names and company name, applies the selected country calendar and can generate an initial schedule. The result is returned in the response; nothing is saved on the server or in a browser.

{
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "description": "ISO country code, for example PL, DE, GB or US."
    },
    "region": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optional region code supported by the selected country."
    },
    "language": {
      "type": "string",
      "description": "Demo language code, for example en, pl, de, fr or es."
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone, for example Europe/Warsaw."
    },
    "kind": {
      "type": "string",
      "enum": [
        "DEMO",
        "EMPTY"
      ]
    },
    "closeOnHolidays": {
      "type": "boolean"
    }
  },
  "description": "Settings for the same projects/create API operation. All fields are optional; defaults are country PL, language en, kind DEMO and the timezone selected for the country.",
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "project": {
      "type": "object"
    },
    "optimization": {
      "type": [
        "object",
        "null"
      ]
    }
  }
}

Validate a complete Rotase project payload without saving or modifying it. Use rotase_examples first if the payload shape is unknown. Call this before feasibility checks or schedule generation. The input is the project object itself, not a wrapper with an additional "project" property.

{
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "string"
    },
    "project": {
      "type": "object"
    },
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "availability": {
      "type": "array"
    },
    "preferences": {
      "type": "array"
    },
    "monthlyTargets": {
      "type": "array"
    },
    "schedules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "project",
    "store",
    "employees"
  ],
  "description": "The complete Rotase project object. Use the object returned as the \"project\" field by rotase_examples as a template. Required top-level sections are project, store and employees; availability, preferences, monthlyTargets and schedules may be empty arrays when unused.",
  "additionalProperties": true
}

{
  "type": "object",
  "description": "Operation-specific Rotase result. Read the returned content and structuredContent fields; validation and feasibility results may contain violations, shortages or explanatory messages.",
  "additionalProperties": true
}

Generate a monthly employee schedule from a complete Rotase project payload. Use rotase_examples to obtain a template, then rotase_validate_project first. The operation calculates and returns a schedule; it does not save a project, modify browser storage or create an account. Explain returned violations or shortages instead of assuming that every project is schedulable.

{
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "string"
    },
    "project": {
      "type": "object"
    },
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "availability": {
      "type": "array"
    },
    "preferences": {
      "type": "array"
    },
    "monthlyTargets": {
      "type": "array"
    },
    "schedules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "project",
    "store",
    "employees"
  ],
  "description": "The complete Rotase project object. Use the object returned as the \"project\" field by rotase_examples as a template. Required top-level sections are project, store and employees; availability, preferences, monthlyTargets and schedules may be empty arrays when unused.",
  "additionalProperties": true
}

{
  "type": "object",
  "description": "Operation-specific Rotase result. Read the returned content and structuredContent fields; validation and feasibility results may contain violations, shortages or explanatory messages.",
  "additionalProperties": true
}

Check whether a complete Rotase project can satisfy opening hours, staffing requirements, availability, rest rules and work-hour limits. Use after rotase_validate_project and before generation when the user asks whether a schedule is possible. This operation is read-only and does not save or modify the project.

{
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "string"
    },
    "project": {
      "type": "object"
    },
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "availability": {
      "type": "array"
    },
    "preferences": {
      "type": "array"
    },
    "monthlyTargets": {
      "type": "array"
    },
    "schedules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "project",
    "store",
    "employees"
  ],
  "description": "The complete Rotase project object. Use the object returned as the \"project\" field by rotase_examples as a template. Required top-level sections are project, store and employees; availability, preferences, monthlyTargets and schedules may be empty arrays when unused.",
  "additionalProperties": true
}

{
  "type": "object",
  "description": "Operation-specific Rotase result. Read the returned content and structuredContent fields; validation and feasibility results may contain violations, shortages or explanatory messages.",
  "additionalProperties": true
}

Calculate per-store and per-employee statistics for a generated monthly schedule. Pass the complete project object and either provide the generated schedule as the top-level "schedule" property or put it in the project schedules array. This operation is read-only and does not save data.

{
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "string"
    },
    "project": {
      "type": "object"
    },
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "availability": {
      "type": "array"
    },
    "preferences": {
      "type": "array"
    },
    "monthlyTargets": {
      "type": "array"
    },
    "schedules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "project",
    "store",
    "employees"
  ],
  "description": "The complete Rotase project object. Use the object returned as the \"project\" field by rotase_examples as a template. Required top-level sections are project, store and employees; availability, preferences, monthlyTargets and schedules may be empty arrays when unused.",
  "additionalProperties": true
}

{
  "type": "object",
  "properties": {
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array"
    }
  }
}

Export a generated monthly schedule as spreadsheet-compatible CSV. Pass the complete project object and either provide the generated schedule as the top-level "schedule" property or put it in the project schedules array. The response contains the CSV text; nothing is saved on the server.

{
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "string"
    },
    "project": {
      "type": "object"
    },
    "store": {
      "type": "object"
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "availability": {
      "type": "array"
    },
    "preferences": {
      "type": "array"
    },
    "monthlyTargets": {
      "type": "array"
    },
    "schedules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "project",
    "store",
    "employees"
  ],
  "description": "The complete Rotase project object. Use the object returned as the \"project\" field by rotase_examples as a template. Required top-level sections are project, store and employees; availability, preferences, monthlyTargets and schedules may be empty arrays when unused.",
  "additionalProperties": true
}

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string"
    },
    "contentType": {
      "type": "string"
    },
    "csv": {
      "type": "string"
    }
  }
}