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.

RequestAppointmentQueryDataContract
NameDescriptionTypeAdditional information
AppointmentType

EnumDataContract

None.

RoleIds

Collection of integer

None.

Location

PointDataContract

None.

Availability

Collection of TimeRangeDataContract

None.

PreferredPersonId

integer

None.

PreferredTeamGroupId

integer

None.

OtherRequiredPeople

Collection of integer

None.

Request Formats

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": "2020-08-11T01:41:41.9952145Z",
      "End": "2020-08-11T01:41:41.9952145Z"
    },
    {
      "Start": "2020-08-11T01:41:41.9952145Z",
      "End": "2020-08-11T01:41:41.9952145Z"
    }
  ],
  "PreferredPersonId": 1,
  "PreferredTeamGroupId": 1,
  "OtherRequiredPeople": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

RequestAppointmentQueryResponseDataContract
NameDescriptionTypeAdditional information
Availability

TimeRangeDataContract

None.

AutomaticallySelectedPeople

Collection of integer

None.

RequiredPeople

Collection of integer

None.

TeamId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Availability": {
    "Start": "2020-08-11T01:41:42.012394Z",
    "End": "2020-08-11T01:41:42.012394Z"
  },
  "AutomaticallySelectedPeople": [
    1,
    2
  ],
  "RequiredPeople": [
    1,
    2
  ],
  "TeamId": 1
}