POST api/appointment/suggest

Auto-picks attendees and the next available appointment slot given the parameters in the request.

Request Information

URI Parameters

None.

Body Parameters

An appointment suggest request containing information about the desired appointment.

Dezrez.Core.DataContracts.External.Api.Scheduling.EventScheduling.RequestAppointmentQueryDataContract

Name	Type	Additional information
AppointmentType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
RoleIds	Collection of integer	None.
Location	Dezrez.Core.DataContracts.External.Api.Location.Query.PointDataContract	None.
Availability	Collection of Dezrez.Core.DataContracts.External.Api.Scheduling.TimeRangeDataContract	None.
PreferredPersonId	integer	None.
PreferredTeamGroupId	integer	None.
OtherRequiredPeople	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "AppointmentType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RoleIds": [
    1,
    2
  ],
  "Location": {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Altitude": 3.1,
    "Order": 4,
    "Id": 5
  },
  "Availability": [
    {
      "Start": "2024-11-21T09:45:10.1357462Z",
      "End": "2024-11-21T09:45:10.1357462Z"
    },
    {
      "Start": "2024-11-21T09:45:10.1357462Z",
      "End": "2024-11-21T09:45:10.1357462Z"
    }
  ],
  "PreferredPersonId": 1,
  "PreferredTeamGroupId": 1,
  "OtherRequiredPeople": [
    1,
    2
  ]
}

Response Information

Resource Description

A data contract that represents a suggested time. The Availability property will be null if there is no suitable availability

Dezrez.Core.DataContracts.External.Api.Scheduling.EventScheduling.RequestAppointmentQueryResponseDataContract

Name	Type	Additional information
Availability	Dezrez.Core.DataContracts.External.Api.Scheduling.TimeRangeDataContract	None.
AutomaticallySelectedPeople	Collection of integer	None.
RequiredPeople	Collection of integer	None.
TeamId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Availability": {
    "Start": "2024-11-21T09:45:10.1513724Z",
    "End": "2024-11-21T09:45:10.1513724Z"
  },
  "AutomaticallySelectedPeople": [
    1,
    2
  ],
  "RequiredPeople": [
    1,
    2
  ],
  "TeamId": 1
}