POST api/Schedule/GetAvailableTimeslots
Get's available timeslots for Provider and Visit Type
Request Information
URI Parameters
None.
Body Parameters
AvailableTiemslotRequestDTO item
AvailableTimeslotRequestName | Description | Type | Additional information |
---|---|---|---|
ProviderID |
The Epic ID of the Provider whose schedule you wish to view. |
string |
None. |
DepartmentID |
The Epic ID of the Department of the Provider whose schedule you wish to view. |
string |
None. |
VisitType |
The Visit Type for the schedule you wish to view |
string |
None. |
StartDate |
Do not return timeslots prior to this date |
string |
None. |
EndDate |
Do not return timeslots after this dte |
string |
None. |
Count | integer |
None. |
|
SearchForward | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "ProviderID": "sample string 1", "DepartmentID": "sample string 2", "VisitType": "sample string 3", "StartDate": "sample string 4", "EndDate": "sample string 5", "Count": 6, "SearchForward": true }
application/xml, text/xml
Sample:
<AvailableTimeslotRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicCnx.Models"> <Count>6</Count> <DepartmentID>sample string 2</DepartmentID> <EndDate>sample string 5</EndDate> <ProviderID>sample string 1</ProviderID> <SearchForward>true</SearchForward> <StartDate>sample string 4</StartDate> <VisitType>sample string 3</VisitType> </AvailableTimeslotRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Available Timeslots
AvailableSlotsName | Description | Type | Additional information |
---|---|---|---|
DepartmentID |
Epic Department ID |
string |
None. |
DepartmentIDType | string |
None. |
|
ProviderID |
Epic Provider ID |
string |
None. |
ProviderIDType | string |
None. |
|
VisitType |
Epic Visit Type |
string |
None. |
VisitTypeIDType | string |
None. |
|
Timeslots |
Date and time the appointment begins |
Collection of AvailableDates |
None. |
Error | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "DepartmentID": "sample string 1", "DepartmentIDType": "sample string 2", "ProviderID": "sample string 3", "ProviderIDType": "sample string 4", "VisitType": "sample string 5", "VisitTypeIDType": "sample string 6", "Timeslots": [ { "AvailableDate": "sample string 1", "AvailableTimes": [ "sample string 1", "sample string 2" ] }, { "AvailableDate": "sample string 1", "AvailableTimes": [ "sample string 1", "sample string 2" ] } ], "Error": "sample string 7" }
application/xml, text/xml
Sample:
<AvailableSlots xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicCnx.Models"> <DepartmentID>sample string 1</DepartmentID> <DepartmentIDType>sample string 2</DepartmentIDType> <Error>sample string 7</Error> <ProviderID>sample string 3</ProviderID> <ProviderIDType>sample string 4</ProviderIDType> <Timeslots> <AvailableDates> <AvailableDate>sample string 1</AvailableDate> <AvailableTimes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </AvailableTimes> </AvailableDates> <AvailableDates> <AvailableDate>sample string 1</AvailableDate> <AvailableTimes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </AvailableTimes> </AvailableDates> </Timeslots> <VisitType>sample string 5</VisitType> <VisitTypeIDType>sample string 6</VisitTypeIDType> </AvailableSlots>