Ecw Search available slots

POSThttps://preview.ontross.com/api/integrations/ecw/search-available-slots

input.provider_name

string

required

Clinician display name identifying the resource to search.

Example

"Rivera, Alex"

input.visit_type

string

required

Exact visit-type code configured in your ECW practice for the selected provider (for example, OB CHK). Available codes vary by practice and provider.

Example

"Office visit"

input.start_date

string

required

First search date in MM/DD/YYYY format

Example

"01/15/2026"

input.start_time

string

Earliest local wall time in HH:MM format. Default: null (no start-time filter).

Example

"09:00"

input.end_time

string

Latest local wall time in HH:MM format. Default: null (no end-time filter). Must be later than start_time when both are supplied.

Example

"17:00"

input.days

array

Days of the week to search. Default: [] (no day-of-week filter).

Example

["mon","wed","fri"]

Default

[]

Accepted values

sunmontuewedthufrisat

input.schedule_interval_minutes

integer

Scheduling grid interval in minutes (nSchDuration). Default: 15. The provider/visit type determines visit duration.

Example

15

Default

15

input.result_size

integer

Maximum number of slots to return, from 1 to 100. Default: 100.

Example

10

Default

100

input.respect_visit_type_rules

boolean

Apply the provider's configured visit-type scheduling rules. Default: true.

Example

true

Default

true

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

slots

array

Available appointment openings matching the requested search criteria.

slots[].date

string

Calendar day returned for the available appointment opening.

Example

"2026-01-15"

slots[].datetime

string

ECW display date/time string, without timezone conversion

Example

"2026-01-15T09:00:00"

slots[].startTime

string

Beginning clock time returned for the appointment opening.

Example

"09:00:00"

slots[].slotduration

integer

Positive length of the available appointment opening.

Example

30

slots[].providerId

integer

Clinician identifier returned for the available appointment opening.

Example

100003

slots[].providerName

string

Clinician display label returned for the appointment opening.

Example

"Rivera, Alex"

slots[].providerNameAndId

string

Combined clinician display label and source identifier.

Example

"Example,Alex (9001)"

slots[].bookProviderId

integer

Clinician identifier used for booking the available opening.

Example

100003

slots[].facilityId

integer

Source identifier of the opening's care location.

Example

100004

slots[].facilityName

string

Display label of the opening's care location.

Example

"Example Family Clinic"

slots[].facilityTimeZone

string

Timezone associated with the opening's care location.

Example

"America/New_York"

slots[].facilitytimezoneTime

string

Clock time expressed for the care location's timezone.

Example

"16:15:00"

slots[].resourceTimeZone

string

Timezone associated with the bookable scheduling resource.

Example

"America/New_York"

slots[].userType

integer

Numeric source classification of the scheduling user.

Example

1

slots[].visitType

string

Appointment classification returned for the available opening.

Example

"Office visit"

slots[].duration

string

Source text describing the appointment's scheduled length.

Example

"15"

result_count

integer

Number of available openings returned in this response.

Example

1

visit_duration_minutes

integer

Appointment length determined by clinician and visit classification.

Example

30

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/search-available-slots \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"days":[],"provider_name":"Example, Provider","respect_visit_type_rules":true,"result_size":100,"schedule_interval_minutes":15,"start_date":"10/06/2026","visit_type":"OB CHK"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "days": [],
    "provider_name": "Example, Provider",
    "respect_visit_type_rules": true,
    "result_size": 100,
    "schedule_interval_minutes": 15,
    "start_date": "10/06/2026",
    "visit_type": "OB CHK"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "slots": [
      {
        "date": "2026-01-15",
        "datetime": "2026-01-15T09:00:00",
        "startTime": "09:00:00",
        "slotduration": 30,
        "providerId": 100003,
        "providerName": "Rivera, Alex",
        "providerNameAndId": "Example,Alex (9001)",
        "bookProviderId": 100003,
        "facilityId": 100004,
        "facilityName": "Example Family Clinic",
        "facilityTimeZone": "America/New_York",
        "facilitytimezoneTime": "16:15:00",
        "resourceTimeZone": "America/New_York",
        "userType": 1,
        "visitType": "Office visit",
        "duration": "15"
      }
    ],
    "result_count": 1,
    "visit_duration_minutes": 30
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}