POST
/
roster-plans
/
{uuid}
/
generate
Generate and persist draft assignments
curl --request POST \
  --url https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{server}.sanicus-connect.com/staff/roster-plans/{uuid}/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "date": "2023-12-25",
    "assignments": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "uuidShift": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "shiftName": "<string>",
        "uuidStaff": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "staffName": "<string>",
        "travelCostMins": 123,
        "previousZone": "<string>",
        "autoFilled": true
      }
    ],
    "understaffedSlots": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        }
      }
    ],
    "totalTravelMinutes": 123
  }
]
[
  {
    "date": "2023-12-25",
    "assignments": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "uuidShift": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "shiftName": "<string>",
        "uuidStaff": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "staffName": "<string>",
        "travelCostMins": 123,
        "previousZone": "<string>",
        "autoFilled": true
      }
    ],
    "understaffedSlots": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        }
      }
    ],
    "totalTravelMinutes": 123
  }
]
[
  {
    "date": "2023-12-25",
    "assignments": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "uuidShift": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "shiftName": "<string>",
        "uuidStaff": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "staffName": "<string>",
        "travelCostMins": 123,
        "previousZone": "<string>",
        "autoFilled": true
      }
    ],
    "understaffedSlots": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        }
      }
    ],
    "totalTravelMinutes": 123
  }
]
[
  {
    "date": "2023-12-25",
    "assignments": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "uuidShift": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "shiftName": "<string>",
        "uuidStaff": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "staffName": "<string>",
        "travelCostMins": 123,
        "previousZone": "<string>",
        "autoFilled": true
      }
    ],
    "understaffedSlots": [
      {
        "uuidOperatingZone": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "zoneName": "<string>",
        "slotStartTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        },
        "slotEndTime": {
          "hour": 123,
          "minute": 123,
          "second": 123,
          "nano": 123
        }
      }
    ],
    "totalTravelMinutes": 123
  }
]

Authorizations

​
Authorization
string
header
required

OAuth2 JWT issued by the Sanicus auth server. All endpoints require a valid token.

Path Parameters

​
uuid
string<uuid>
required

UUID of the roster plan

Response

Draft assignments generated

​
date
string<date>
​
assignments
object[]
​
understaffedSlots
object[]
​
totalTravelMinutes
number