POST api/appointments/patientavailabledates

Request Information

URI Parameters

None.

Body Parameters

OpeningsRequest
NameDescriptionTypeAdditional information
Environment

string

None.

APIKey

string

None.

ClinicID

integer

None.

ClinicDB

integer

None.

ProviderID

integer

None.

ProviderDB

integer

None.

AppointmentLength

integer

None.

ProviderType

string

None.

OperatoryNumber

integer

None.

DateRangeTo

string

None.

DateRangeFrom

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Environment": "sample string 1",
  "APIKey": "sample string 2",
  "ClinicID": 3,
  "ClinicDB": 4,
  "ProviderID": 5,
  "ProviderDB": 6,
  "AppointmentLength": 7,
  "ProviderType": "sample string 8",
  "OperatoryNumber": 9,
  "DateRangeTo": "sample string 10",
  "DateRangeFrom": "sample string 11"
}

text/html, text/plain

Sample:
{"Environment":"sample string 1","APIKey":"sample string 2","ClinicID":3,"ClinicDB":4,"ProviderID":5,"ProviderDB":6,"AppointmentLength":7,"ProviderType":"sample string 8","OperatoryNumber":9,"DateRangeTo":"sample string 10","DateRangeFrom":"sample string 11"}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OpeningItemsResponse
NameDescriptionTypeAdditional information
Openings

Collection of OpeningItem2

None.

ResponseMessage

string

None.

ResponseCode

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Openings": [
    {
      "ClinicID": 1,
      "ClinicDB": 2,
      "OperatoryID": 3,
      "OperatoryDB": 4,
      "ProviderID": 5,
      "ProviderDB": 6,
      "OperatoryName": "sample string 7",
      "ProviderName": "sample string 8",
      "ProviderType": "sample string 9",
      "ClinicName": "sample string 10",
      "StartTime": "2024-11-23T05:56:50.2618043-08:00",
      "ApptLen": 12
    },
    {
      "ClinicID": 1,
      "ClinicDB": 2,
      "OperatoryID": 3,
      "OperatoryDB": 4,
      "ProviderID": 5,
      "ProviderDB": 6,
      "OperatoryName": "sample string 7",
      "ProviderName": "sample string 8",
      "ProviderType": "sample string 9",
      "ClinicName": "sample string 10",
      "StartTime": "2024-11-23T05:56:50.2618043-08:00",
      "ApptLen": 12
    }
  ],
  "ResponseMessage": "sample string 1",
  "ResponseCode": 2
}

text/html, text/plain

Sample:
{"Openings":[{"ClinicID":1,"ClinicDB":2,"OperatoryID":3,"OperatoryDB":4,"ProviderID":5,"ProviderDB":6,"OperatoryName":"sample string 7","ProviderName":"sample string 8","ProviderType":"sample string 9","ClinicName":"sample string 10","StartTime":"2024-11-23T05:56:50.2618043-08:00","ApptLen":12},{"ClinicID":1,"ClinicDB":2,"OperatoryID":3,"OperatoryDB":4,"ProviderID":5,"ProviderDB":6,"OperatoryName":"sample string 7","ProviderName":"sample string 8","ProviderType":"sample string 9","ClinicName":"sample string 10","StartTime":"2024-11-23T05:56:50.2618043-08:00","ApptLen":12}],"ResponseMessage":"sample string 1","ResponseCode":2}