POST api/Athena/SearchAppointmentTypes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PracticeId	integer	None.
HideGeneric	boolean	None.
ShowAppointmentTypeClasses	boolean	None.
ProviderIds	Collection of integer	None.
HideTemplateTypeOnly	boolean	None.
DepartmentIds	Collection of integer	None.
HideNonPatient	boolean	None.
HideNonGeneric	boolean	None.
Limit	integer	None.
Offset	integer	None.
slotavailable	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "practiceId": 1,
  "hideGeneric": true,
  "showAppointmentTypeClasses": true,
  "providerIds": [
    1,
    2
  ],
  "hideTemplateTypeOnly": true,
  "departmentIds": [
    1,
    2
  ],
  "hideNonPatient": true,
  "hideNonGeneric": true,
  "limit": 1,
  "offset": 1,
  "slotavailable": true
}

application/xml, text/xml

Sample:

<AppointmentTypesRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.DTO">
  <DepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DepartmentIds>
  <HideGeneric>true</HideGeneric>
  <HideNonGeneric>true</HideNonGeneric>
  <HideNonPatient>true</HideNonPatient>
  <HideTemplateTypeOnly>true</HideTemplateTypeOnly>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <PracticeId>1</PracticeId>
  <ProviderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProviderIds>
  <ShowAppointmentTypeClasses>true</ShowAppointmentTypeClasses>
  <slotavailable>true</slotavailable>
</AppointmentTypesRequestDTO>

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.