GET api/Appointments

Request Information

URI Parameters

None.

Body Parameters

AppointmentDoctorSchedule
NameDescriptionTypeAdditional information
Id

integer

None.

DoctorId

integer

None.

ClientDoctorIdentity

string

String length: inclusive between 0 and 25

LocationId

integer

None.

ClientOfficeIdentity

string

String length: inclusive between 0 and 25

ValidFrom

date

None.

ValidTo

date

None.

AppointmentDateTimeStart

date

None.

AppointmentDateTimeEnd

date

None.

SlotIdentity

integer

None.

Available

boolean

None.

Appointments

Collection of Appointment

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "DoctorId": 2,
  "ClientDoctorIdentity": "sample string 3",
  "LocationId": 4,
  "ClientOfficeIdentity": "sample string 5",
  "ValidFrom": "2024-04-20T09:11:00.1763795-05:00",
  "ValidTo": "2024-04-20T09:11:00.1763795-05:00",
  "AppointmentDateTimeStart": "2024-04-20T09:11:00.1763795-05:00",
  "AppointmentDateTimeEnd": "2024-04-20T09:11:00.1763795-05:00",
  "SlotIdentity": 1,
  "Available": true,
  "Appointments": [
    {
      "Id": 1,
      "LocationId": 2,
      "DoctorScheduleSlotId": 3,
      "AppointmentTypeId": 4,
      "AppointmentStatusId": 5,
      "PatientId": 6,
      "ApptSource": "sample string 7",
      "SubmitTime": "2024-04-20T09:11:00.1763795-05:00",
      "Notes": "sample string 9",
      "ValidFrom": "2024-04-20T09:11:00.1763795-05:00",
      "ValidTo": "2024-04-20T09:11:00.1763795-05:00",
      "AppointmentIdentity": "sample string 12"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppointmentDoctorSchedule
NameDescriptionTypeAdditional information
Id

integer

None.

DoctorId

integer

None.

ClientDoctorIdentity

string

String length: inclusive between 0 and 25

LocationId

integer

None.

ClientOfficeIdentity

string

String length: inclusive between 0 and 25

ValidFrom

date

None.

ValidTo

date

None.

AppointmentDateTimeStart

date

None.

AppointmentDateTimeEnd

date

None.

SlotIdentity

integer

None.

Available

boolean

None.

Appointments

Collection of Appointment

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "DoctorId": 2,
  "ClientDoctorIdentity": "sample string 3",
  "LocationId": 4,
  "ClientOfficeIdentity": "sample string 5",
  "ValidFrom": "2024-04-20T09:11:00.2232861-05:00",
  "ValidTo": "2024-04-20T09:11:00.2232861-05:00",
  "AppointmentDateTimeStart": "2024-04-20T09:11:00.2232861-05:00",
  "AppointmentDateTimeEnd": "2024-04-20T09:11:00.2232861-05:00",
  "SlotIdentity": 1,
  "Available": true,
  "Appointments": [
    {
      "Id": 1,
      "LocationId": 2,
      "DoctorScheduleSlotId": 3,
      "AppointmentTypeId": 4,
      "AppointmentStatusId": 5,
      "PatientId": 6,
      "ApptSource": "sample string 7",
      "SubmitTime": "2024-04-20T09:11:00.2232861-05:00",
      "Notes": "sample string 9",
      "ValidFrom": "2024-04-20T09:11:00.2232861-05:00",
      "ValidTo": "2024-04-20T09:11:00.2232861-05:00",
      "AppointmentIdentity": "sample string 12"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.