POST api/appointments/nextappointments

Request Information

URI Parameters

None.

Body Parameters

AppointmentExistingInputs
NameDescriptionTypeAdditional information
Environment

string

None.

APIKey

string

None.

PatientID

integer

None.

PatientDB

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Environment": "sample string 1",
  "APIKey": "sample string 2",
  "PatientID": 3,
  "PatientDB": 4
}

text/html, text/plain

Sample:
{"Environment":"sample string 1","APIKey":"sample string 2","PatientID":3,"PatientDB":4}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppointmentsResponse
NameDescriptionTypeAdditional information
Appointments

Collection of PatientAppointment

None.

ResponseMessage

string

None.

ResponseCode

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Appointments": [
    {
      "AppointmentID": 1,
      "ClinicID": 2,
      "OperatoryID": 3,
      "OperatoryDB": 4,
      "ProviderID": 5,
      "ProviderDB": 6,
      "StartTime": "2024-11-23T05:46:42.4800347-08:00",
      "ApptLen": 8
    },
    {
      "AppointmentID": 1,
      "ClinicID": 2,
      "OperatoryID": 3,
      "OperatoryDB": 4,
      "ProviderID": 5,
      "ProviderDB": 6,
      "StartTime": "2024-11-23T05:46:42.4800347-08:00",
      "ApptLen": 8
    }
  ],
  "ResponseMessage": "sample string 1",
  "ResponseCode": 2
}

text/html, text/plain

Sample:
{"Appointments":[{"AppointmentID":1,"ClinicID":2,"OperatoryID":3,"OperatoryDB":4,"ProviderID":5,"ProviderDB":6,"StartTime":"2024-11-23T05:46:42.4800347-08:00","ApptLen":8},{"AppointmentID":1,"ClinicID":2,"OperatoryID":3,"OperatoryDB":4,"ProviderID":5,"ProviderDB":6,"StartTime":"2024-11-23T05:46:42.4800347-08:00","ApptLen":8}],"ResponseMessage":"sample string 1","ResponseCode":2}