POST api/Schedule/GetProviderAvailableSlots

Request Information

URI Parameters

None.

Body Parameters

AvailableTimeslotRequest
NameDescriptionTypeAdditional 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

ProviderAvailableSlots
NameDescriptionTypeAdditional information
Providers

Collection of Provider

None.

Error

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Providers": [
    {
      "ItemID": 1,
      "FName": "sample string 2",
      "LName": "sample string 3",
      "Title": "sample string 4",
      "FullName": "sample string 5",
      "EPICID": "sample string 6",
      "SpecialtyText": "sample string 7",
      "Gender": "sample string 8",
      "Photo1": "sample string 9",
      "PhotoWide": "sample string 10",
      "InformationalHeader": "sample string 11",
      "Offices": [
        {
          "OfficeNameID": 1,
          "OfficeName": "sample string 2",
          "StreetAddress": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "Zip": "sample string 6",
          "Region": "sample string 7",
          "Phone": "sample string 8",
          "Fax": "sample string 9",
          "EpicDeptID": "sample string 10",
          "Latitude": 11.0,
          "Longitude": 12.0
        },
        {
          "OfficeNameID": 1,
          "OfficeName": "sample string 2",
          "StreetAddress": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "Zip": "sample string 6",
          "Region": "sample string 7",
          "Phone": "sample string 8",
          "Fax": "sample string 9",
          "EpicDeptID": "sample string 10",
          "Latitude": 11.0,
          "Longitude": 12.0
        }
      ],
      "Slots": {
        "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"
      }
    },
    {
      "ItemID": 1,
      "FName": "sample string 2",
      "LName": "sample string 3",
      "Title": "sample string 4",
      "FullName": "sample string 5",
      "EPICID": "sample string 6",
      "SpecialtyText": "sample string 7",
      "Gender": "sample string 8",
      "Photo1": "sample string 9",
      "PhotoWide": "sample string 10",
      "InformationalHeader": "sample string 11",
      "Offices": [
        {
          "OfficeNameID": 1,
          "OfficeName": "sample string 2",
          "StreetAddress": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "Zip": "sample string 6",
          "Region": "sample string 7",
          "Phone": "sample string 8",
          "Fax": "sample string 9",
          "EpicDeptID": "sample string 10",
          "Latitude": 11.0,
          "Longitude": 12.0
        },
        {
          "OfficeNameID": 1,
          "OfficeName": "sample string 2",
          "StreetAddress": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "Zip": "sample string 6",
          "Region": "sample string 7",
          "Phone": "sample string 8",
          "Fax": "sample string 9",
          "EpicDeptID": "sample string 10",
          "Latitude": 11.0,
          "Longitude": 12.0
        }
      ],
      "Slots": {
        "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"
      }
    }
  ],
  "Error": "sample string 1"
}

application/xml, text/xml

Sample:
<ProviderAvailableSlots xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicCnx.Models">
  <Error>sample string 1</Error>
  <Providers>
    <Provider>
      <EPICID>sample string 6</EPICID>
      <FName>sample string 2</FName>
      <FullName>sample string 5</FullName>
      <Gender>sample string 8</Gender>
      <InformationalHeader>sample string 11</InformationalHeader>
      <ItemID>1</ItemID>
      <LName>sample string 3</LName>
      <Offices>
        <OfficeLocation>
          <City>sample string 4</City>
          <EpicDeptID>sample string 10</EpicDeptID>
          <Fax>sample string 9</Fax>
          <Latitude>11</Latitude>
          <Longitude>12</Longitude>
          <OfficeName>sample string 2</OfficeName>
          <OfficeNameID>1</OfficeNameID>
          <Phone>sample string 8</Phone>
          <Region>sample string 7</Region>
          <State>sample string 5</State>
          <StreetAddress>sample string 3</StreetAddress>
          <Zip>sample string 6</Zip>
        </OfficeLocation>
        <OfficeLocation>
          <City>sample string 4</City>
          <EpicDeptID>sample string 10</EpicDeptID>
          <Fax>sample string 9</Fax>
          <Latitude>11</Latitude>
          <Longitude>12</Longitude>
          <OfficeName>sample string 2</OfficeName>
          <OfficeNameID>1</OfficeNameID>
          <Phone>sample string 8</Phone>
          <Region>sample string 7</Region>
          <State>sample string 5</State>
          <StreetAddress>sample string 3</StreetAddress>
          <Zip>sample string 6</Zip>
        </OfficeLocation>
      </Offices>
      <Photo1>sample string 9</Photo1>
      <PhotoWide>sample string 10</PhotoWide>
      <Slots>
        <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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </AvailableTimes>
          </AvailableDates>
          <AvailableDates>
            <AvailableDate>sample string 1</AvailableDate>
            <AvailableTimes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </AvailableTimes>
          </AvailableDates>
        </Timeslots>
        <VisitType>sample string 5</VisitType>
        <VisitTypeIDType>sample string 6</VisitTypeIDType>
      </Slots>
      <SpecialtyText>sample string 7</SpecialtyText>
      <Title>sample string 4</Title>
    </Provider>
    <Provider>
      <EPICID>sample string 6</EPICID>
      <FName>sample string 2</FName>
      <FullName>sample string 5</FullName>
      <Gender>sample string 8</Gender>
      <InformationalHeader>sample string 11</InformationalHeader>
      <ItemID>1</ItemID>
      <LName>sample string 3</LName>
      <Offices>
        <OfficeLocation>
          <City>sample string 4</City>
          <EpicDeptID>sample string 10</EpicDeptID>
          <Fax>sample string 9</Fax>
          <Latitude>11</Latitude>
          <Longitude>12</Longitude>
          <OfficeName>sample string 2</OfficeName>
          <OfficeNameID>1</OfficeNameID>
          <Phone>sample string 8</Phone>
          <Region>sample string 7</Region>
          <State>sample string 5</State>
          <StreetAddress>sample string 3</StreetAddress>
          <Zip>sample string 6</Zip>
        </OfficeLocation>
        <OfficeLocation>
          <City>sample string 4</City>
          <EpicDeptID>sample string 10</EpicDeptID>
          <Fax>sample string 9</Fax>
          <Latitude>11</Latitude>
          <Longitude>12</Longitude>
          <OfficeName>sample string 2</OfficeName>
          <OfficeNameID>1</OfficeNameID>
          <Phone>sample string 8</Phone>
          <Region>sample string 7</Region>
          <State>sample string 5</State>
          <StreetAddress>sample string 3</StreetAddress>
          <Zip>sample string 6</Zip>
        </OfficeLocation>
      </Offices>
      <Photo1>sample string 9</Photo1>
      <PhotoWide>sample string 10</PhotoWide>
      <Slots>
        <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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </AvailableTimes>
          </AvailableDates>
          <AvailableDates>
            <AvailableDate>sample string 1</AvailableDate>
            <AvailableTimes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </AvailableTimes>
          </AvailableDates>
        </Timeslots>
        <VisitType>sample string 5</VisitType>
        <VisitTypeIDType>sample string 6</VisitTypeIDType>
      </Slots>
      <SpecialtyText>sample string 7</SpecialtyText>
      <Title>sample string 4</Title>
    </Provider>
  </Providers>
</ProviderAvailableSlots>