Retrieve a labour's availability calendar

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/labours/0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d/availability" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.labours.getLabourCalendar('0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d');
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.labours.labours_dto.LaboursDto.LabourCalendar;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<LabourCalendar> response = client.labours().getLabourCalendar("0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Labours.GetLabourCalendarAsync("0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Labours().GetLabourCalendar(context.Background(), "0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "labour_calendar": {
    "available_list": "<array>",
    "code": "<string>",
    "display_name": "<string>",
    "email_address": "<string>",
    "id": "<string>",
    "labour_profile": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "name": "<string>",
    "object": "<string>",
    "processed_schedule_list": {},
    "schedule_list": [
      {
        "available": true,
        "end_time": "<string>",
        "id": "<string>",
        "object": "<string>",
        "preferred_day": "<string>",
        "start_time": "<string>"
      }
    ],
    "session_list": [
      {
        "end_date": "<string>",
        "name": "<string>",
        "processed_schedule_list": {},
        "schedule_list": [
          {
            "available": "<string>",
            "end_time": "<string>",
            "preferred_day": "<string>",
            "start_time": "<string>",
            "uuid": "<string>"
          }
        ],
        "start_date": "<string>",
        "uuid": "<string>"
      }
    ],
    "status": "<string>",
    "unavailable_list": "<array>",
    "use_custom_availability": true,
    "version": 123
  }
}

GET

labours

{labour_id}

availability

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/labours/0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d/availability" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.labours.getLabourCalendar('0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d');
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.labours.labours_dto.LaboursDto.LabourCalendar;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<LabourCalendar> response = client.labours().getLabourCalendar("0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Labours.GetLabourCalendarAsync("0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Labours().GetLabourCalendar(context.Background(), "0b6f3d2a-8c4e-4f1a-9d7b-2e5c8a1f3b6d", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "labour_calendar": {
    "available_list": "<array>",
    "code": "<string>",
    "display_name": "<string>",
    "email_address": "<string>",
    "id": "<string>",
    "labour_profile": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "name": "<string>",
    "object": "<string>",
    "processed_schedule_list": {},
    "schedule_list": [
      {
        "available": true,
        "end_time": "<string>",
        "id": "<string>",
        "object": "<string>",
        "preferred_day": "<string>",
        "start_time": "<string>"
      }
    ],
    "session_list": [
      {
        "end_date": "<string>",
        "name": "<string>",
        "processed_schedule_list": {},
        "schedule_list": [
          {
            "available": "<string>",
            "end_time": "<string>",
            "preferred_day": "<string>",
            "start_time": "<string>",
            "uuid": "<string>"
          }
        ],
        "start_date": "<string>",
        "uuid": "<string>"
      }
    ],
    "status": "<string>",
    "unavailable_list": "<array>",
    "use_custom_availability": true,
    "version": 123
  }
}

Returns the labour’s calendar under labour_calendar, in the same form as one entry of the labour availability list: its schedule, sessions and available and unavailable slots. The path takes the labour’s id or its code.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

labour_id

string

required

The labour's id or its code.

Response

200 - application/json

The calendar, under labour_calendar.

labour_calendar

object

Show child attributes

Guides

API reference

Retrieve a labour's availability calendar

Authorizations

Path Parameters

Response