POST api/appointment/freebusy

Returns Free/Busy information regarding multiple people.

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Scheduling.FreeBusy.PeopleFreeBusyQueryDataContract
NameDescriptionTypeAdditional information
Scope

Dezrez.Core.DataContracts.External.Api.Scheduling.TimeRangeDataContract

None.

PersonIds

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Scope": {
    "Start": "2024-02-25T14:11:50.6283834Z",
    "End": "2024-02-25T14:11:50.6283834Z"
  },
  "PersonIds": [
    1,
    2
  ]
}

Response Information

Resource Description

A list of free/busy information, by person.

Collection of Dezrez.Core.DataContracts.External.Api.Scheduling.FreeBusy.PeopleFreeBusyQueryResponseDataContract
NameDescriptionTypeAdditional information
PersonId

integer

None.

BusyTimeRanges

Collection of Dezrez.Core.DataContracts.External.Api.Scheduling.TimeRangeDataContract

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PersonId": 1,
    "BusyTimeRanges": [
      {
        "Start": "2024-02-25T14:11:50.6283834Z",
        "End": "2024-02-25T14:11:50.6283834Z"
      },
      {
        "Start": "2024-02-25T14:11:50.6283834Z",
        "End": "2024-02-25T14:11:50.6283834Z"
      }
    ]
  },
  {
    "PersonId": 1,
    "BusyTimeRanges": [
      {
        "Start": "2024-02-25T14:11:50.6283834Z",
        "End": "2024-02-25T14:11:50.6283834Z"
      },
      {
        "Start": "2024-02-25T14:11:50.6283834Z",
        "End": "2024-02-25T14:11:50.6283834Z"
      }
    ]
  }
]