Preview swap acceptance

POST

/v1/rotations/{rotationId}/swap-requests/{requestId}/accept/preview

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/swap-requests/example/accept/preview"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"operationId\": \"example\", \"expectedRevision\": 1, \"acknowledgedConflictIds\": [ \"example\" ], \"acknowledgedStartedLegKeys\": [ \"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/swap-requests/example/accept/preview"

  payload := strings.NewReader("{ \"operationId\": \"example\", \"expectedRevision\": 1, \"acknowledgedConflictIds\": [ \"example\" ], \"acknowledgedStartedLegKeys\": [ \"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\", \"expectedRevision\": 1, \"acknowledgedConflictIds\": [ \"example\" ], \"acknowledgedStartedLegKeys\": [ \"example\" ] }");
Request request = new Request.Builder()
  .url("https://api.roundrobinbot.eu/v1/rotations/example/swap-requests/example/accept/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/swap-requests/example/accept/preview',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  data: '{ "operationId": "example", "expectedRevision": 1, "acknowledgedConflictIds": [ "example" ], "acknowledgedStartedLegKeys": [ "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/swap-requests/example/accept/preview';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '{ "operationId": "example", "expectedRevision": 1, "acknowledgedConflictIds": [ "example" ], "acknowledgedStartedLegKeys": [ "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/swap-requests/example/accept/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "operationId": "example", "expectedRevision": 1, "acknowledgedConflictIds": [ "example" ], "acknowledgedStartedLegKeys": [ "example" ] }'

Requires a Slack member access token and the current request revision in expectedRevision. Returns conflicts and the rotation ETag without accepting the request. Review the conflicts before acknowledging them in the acceptance request.

Authorizations

Participant

Parameters

Path Parameters

rotationId

required

string

requestId

required

string

Request Body^required

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

The reviewed request revision, conflict acknowledgments and remaining-time consent for a swap response.

object

operationId

A caller-generated identifier of at most 128 characters. Reuse it only for an identical retry.

string

expectedRevision

The request revision reviewed by the caller.

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

acknowledgedConflictIds

Current conflict identifiers acknowledged for the interval this caller would receive.

Array<string>

acknowledgedStartedLegKeys

Keys of started intervals whose remaining time the recipient agrees to exchange. Include every preview leg with hasStarted set to true when accepting.

Array<string>

Example^generated

{
  "operationId": "example",
  "expectedRevision": 1,
  "acknowledgedConflictIds": [
    "example"
  ],
  "acknowledgedStartedLegKeys": [
    "example"
  ]
}

Responses

200

application/json

The proposed assignments and whether conflict acknowledgments and remaining-time consent permit proceeding.

object

legs

required

Array<object>

One proposed assignment and its conflicts. canAcknowledge identifies conflicts this caller may acknowledge. When hasStarted is true, from and to describe the remaining time; accepting requires its key in acknowledgedStartedLegKeys.

object

key

required

string

assigneeUserId

required

string

from

required

string format: date-time

required

string format: date-time

conflicts

required

Array<object>

A conflict or an uncertainty affecting the proposed assignment.

object

required

The acknowledgment identifier for this conflict and the previewed terms.

string

type

required

absence, sameCellArrangement or unknownAvailability.

string

userId

required

The affected person’s Slack user identifier.

string

from

required

The inclusive UTC start of the conflict intersection with the requested interval.

string format: date-time

required

The exclusive UTC end of the conflict intersection with the requested interval.

string format: date-time

source

required

arrangement, manualAvailability, googleCalendar or slackStatus.

string

canAcknowledge

required

Whether explicit acknowledgment permits proceeding with this conflict. False means the conflict blocks the write.

boolean

canAcknowledge

required

boolean

acknowledged

boolean

hasStarted

boolean

canProceed

required

boolean

Example

{
  "legs": [
    {
      "acknowledged": false,
      "hasStarted": false
    }
  ]
}

Preview swap acceptance

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated