POST api/Athena/GetAppointments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PracticeId	integer	None.
AppointmentTypeId	string	None.
AppointmentStatus	string	None.
DepartmentId	Collection of integer	None.
ShowPatientInstructions	boolean	None.
ProviderId	Collection of integer	None.
IgnoreRestrictions	boolean	None.
ShowPatientDetail	boolean	None.
ConfidentialityCode	Collection of integer	None.
PatientId	string	None.
StartLastModified	string	None.
ShowInsurance	boolean	None.
ScheduledStartDate	string	None.
ShowReminderCallDetail	boolean	None.
EndLastModified	string	None.
EndDate	string	None.
ShowExpectedProcedureCodes	boolean	None.
ShowClaimDetail	boolean	None.
ShowCopay	boolean	None.
ScheduledEndDate	string	None.
ShowCancelled	boolean	None.
StartDate	string	None.
Limit	integer	None.
Offset	integer	None.
IsEMRRefresh	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "practiceId": 1,
  "appointmentTypeId": "sample string 2",
  "appointmentStatus": "sample string 3",
  "departmentId": [
    1,
    2
  ],
  "showPatientInstructions": true,
  "providerId": [
    1,
    2
  ],
  "ignoreRestrictions": true,
  "showPatientDetail": true,
  "confidentialityCode": [
    1,
    2
  ],
  "patientId": "sample string 4",
  "startLastModified": "sample string 5",
  "showInsurance": true,
  "scheduledStartDate": "sample string 6",
  "showReminderCallDetail": true,
  "endLastModified": "sample string 7",
  "endDate": "sample string 8",
  "showExpectedProcedureCodes": true,
  "showClaimDetail": true,
  "showCopay": true,
  "scheduledEndDate": "sample string 9",
  "showCancelled": true,
  "startDate": "sample string 10",
  "limit": 1,
  "offset": 1,
  "isEMRRefresh": true
}

application/xml, text/xml

Sample:

<AthenaAppointmentRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.DTO">
  <AppointmentStatus>sample string 3</AppointmentStatus>
  <AppointmentTypeId>sample string 2</AppointmentTypeId>
  <ConfidentialityCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ConfidentialityCode>
  <DepartmentId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DepartmentId>
  <EndDate>sample string 8</EndDate>
  <EndLastModified>sample string 7</EndLastModified>
  <IgnoreRestrictions>true</IgnoreRestrictions>
  <IsEMRRefresh>true</IsEMRRefresh>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <PatientId>sample string 4</PatientId>
  <PracticeId>1</PracticeId>
  <ProviderId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProviderId>
  <ScheduledEndDate>sample string 9</ScheduledEndDate>
  <ScheduledStartDate>sample string 6</ScheduledStartDate>
  <ShowCancelled>true</ShowCancelled>
  <ShowClaimDetail>true</ShowClaimDetail>
  <ShowCopay>true</ShowCopay>
  <ShowExpectedProcedureCodes>true</ShowExpectedProcedureCodes>
  <ShowInsurance>true</ShowInsurance>
  <ShowPatientDetail>true</ShowPatientDetail>
  <ShowPatientInstructions>true</ShowPatientInstructions>
  <ShowReminderCallDetail>true</ShowReminderCallDetail>
  <StartDate>sample string 10</StartDate>
  <StartLastModified>sample string 5</StartLastModified>
</AthenaAppointmentRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.