Preview a duty arrangement
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/preview"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"operationId\": \"example\", \"cellId\": \"example\", \"userId\": \"example\", \"from\": \"2026-04-15T12:00:00Z\", \"to\": \"2026-04-15T12:00:00Z\", \"expectedRevision\": 1, \"turnSelection\": { \"kind\": \"example\", \"from\": \"2026-04-15T12:00:00Z\", \"to\": \"2026-04-15T12:00:00Z\" }, \"acknowledgedConflictIds\": [ \"example\" ] }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json-patch+json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/preview"
payload := strings.NewReader("{ \"operationId\": \"example\", \"cellId\": \"example\", \"userId\": \"example\", \"from\": \"2026-04-15T12:00:00Z\", \"to\": \"2026-04-15T12:00:00Z\", \"expectedRevision\": 1, \"turnSelection\": { \"kind\": \"example\", \"from\": \"2026-04-15T12:00:00Z\", \"to\": \"2026-04-15T12:00:00Z\" }, \"acknowledgedConflictIds\": [ \"example\" ] }")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>") req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json-patch+json");RequestBody body = RequestBody.create(mediaType, "{ \"operationId\": \"example\", \"cellId\": \"example\", \"userId\": \"example\", \"from\": \"2026-04-15T12:00:00Z\", \"to\": \"2026-04-15T12:00:00Z\", \"expectedRevision\": 1, \"turnSelection\": { \"kind\": \"example\", \"from\": \"2026-04-15T12:00:00Z\", \"to\": \"2026-04-15T12:00:00Z\" }, \"acknowledgedConflictIds\": [ \"example\" ] }");Request request = new Request.Builder() .url("https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/preview") .post(body) .addHeader("Authorization", "Bearer <token>") .addHeader("Content-Type", "application/json-patch+json") .build();
Response response = client.newCall(request).execute();import axios from 'axios';
const options = { method: 'POST', url: 'https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/preview', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'}, data: '{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ] }'};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}const url = 'https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/preview';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'}, body: '{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ] }'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.roundrobinbot.eu/v1/rotations/example/duty-arrangements/preview \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json-patch+json' \ --data '{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ] }'Requires read:oncall and permission to assign duty for the selected cell. No duty changes. Send UTC terms and the editor’s acknowledged conflict identifiers. Inspect canCommit and conflicts. For a change, include arrangementId and its current expectedRevision. The write rechecks authority, terms and conflicts; preview does not reserve the interval.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The rotation identifier.
Query Parameters
Section titled “Query Parameters”The existing direct assignment when previewing a change; omit for a new assignment.
Request Bodyrequired
Section titled “Request Bodyrequired”Request cancellation.
Terms for a direct assignment or its preview.
object
A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.
The rotation cell receiving the assignment.
The Slack user identifier of a person in the cell’s lane.
The requested inclusive UTC start. A current assignment begins at the actual transition time.
The exclusive UTC end, later than both the start and the write’s transition time.
The current arrangement revision when changing an existing assignment or previewing that change.
Optional turn selection returned by the assignment preview.
object
fullTurn or remainingTurn, as returned by the preview.
The inclusive UTC start of the original turn, including any part already served.
The exclusive UTC end of the original turn.
Conflict identifiers explicitly acknowledged by the rotation editor.
Examplegenerated
{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ]}Terms for a direct assignment or its preview.
object
A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.
The rotation cell receiving the assignment.
The Slack user identifier of a person in the cell’s lane.
The requested inclusive UTC start. A current assignment begins at the actual transition time.
The exclusive UTC end, later than both the start and the write’s transition time.
The current arrangement revision when changing an existing assignment or previewing that change.
Optional turn selection returned by the assignment preview.
object
fullTurn or remainingTurn, as returned by the preview.
The inclusive UTC start of the original turn, including any part already served.
The exclusive UTC end of the original turn.
Conflict identifiers explicitly acknowledged by the rotation editor.
Examplegenerated
{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ]}Terms for a direct assignment or its preview.
object
A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.
The rotation cell receiving the assignment.
The Slack user identifier of a person in the cell’s lane.
The requested inclusive UTC start. A current assignment begins at the actual transition time.
The exclusive UTC end, later than both the start and the write’s transition time.
The current arrangement revision when changing an existing assignment or previewing that change.
Optional turn selection returned by the assignment preview.
object
fullTurn or remainingTurn, as returned by the preview.
The inclusive UTC start of the original turn, including any part already served.
The exclusive UTC end of the original turn.
Conflict identifiers explicitly acknowledged by the rotation editor.
Examplegenerated
{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ]}Terms for a direct assignment or its preview.
object
A nonempty operation identifier of at most 128 characters, required for writes. Reuse it only to retry the same write.
The rotation cell receiving the assignment.
The Slack user identifier of a person in the cell’s lane.
The requested inclusive UTC start. A current assignment begins at the actual transition time.
The exclusive UTC end, later than both the start and the write’s transition time.
The current arrangement revision when changing an existing assignment or previewing that change.
Optional turn selection returned by the assignment preview.
object
fullTurn or remainingTurn, as returned by the preview.
The inclusive UTC start of the original turn, including any part already served.
The exclusive UTC end of the original turn.
Conflict identifiers explicitly acknowledged by the rotation editor.
Examplegenerated
{ "operationId": "example", "cellId": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "expectedRevision": 1, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "acknowledgedConflictIds": [ "example" ]}Responses
Section titled “Responses”OK
Conflict evaluation for the proposed terms. A preview does not change duty.
object
The later of the requested start and preview time. The actual write can begin later.
The requested exclusive UTC end.
Observed conflicts and source uncertainties.
A conflict or an uncertainty affecting the proposed assignment.
object
The acknowledgment identifier for this conflict and the previewed terms.
absence, sameCellArrangement or unknownAvailability.
The affected person’s Slack user identifier.
The inclusive UTC start of the conflict intersection with the requested interval.
The exclusive UTC end of the conflict intersection with the requested interval.
arrangement, manualAvailability, googleCalendar or slackStatus.
Whether explicit acknowledgment permits proceeding with this conflict. False means the conflict blocks the write.
Whether every observed conflict permits acknowledgment and has been acknowledged. The write rechecks current state.
The verified full or remaining turn for these terms, or null when the interval does not identify one. Copy this value into the write to record the selection.
object
fullTurn or remainingTurn.
The inclusive UTC start of the original turn, including any part already served.
The exclusive UTC end of the original turn.
Examplegenerated
{ "effectiveFrom": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "conflicts": [ { "id": "example", "type": "example", "userId": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "source": "example", "canAcknowledge": true } ], "canCommit": true, "turnSelection": { "kind": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }}