> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automaticrostering.visma.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Keep users informed while a roster is being created.

Roster creation can take time. Poll `GET /roster/status/{jobId}` to keep users
informed from the moment a job starts until all processing is complete.

The response includes fields such as `status`, `hasResult`, and `isActive` for
controlling your application. It also provides two complementary ways to show
users what is happening:

<CardGroup cols={2}>
  <Card title="Metrics" icon="gauge-high" href="/v2/concepts/metrics">
    Show hard numbers that describe the current roster, such as unfilled demand or rule violations.
  </Card>

  <Card title="Messages" icon="message" href="/v2/concepts/status-messages">
    Share detailed, plain-language updates about the stage and progress of the roster job.
  </Card>
</CardGroup>

Use either feature on its own, or combine them to give users both precise values
and a readable account of the work in progress. Configure the updates you want
in `statusOptions` when starting the roster job, then retrieve them while polling
the status endpoint.