GET api/appointmentrequestreasons/search?accountNumber={accountNumber}&newPatient={newPatient}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of reasons.

Request Information

URI Parameters

Name	Description	Type	Additional information
accountNumber	Account number	string	Required
newPatient	Is request for new patient.	boolean	Default value is False
page	Page number requested (search results are paginated).	integer	Default value is 1
itemsPerPage	Items to return on each page. See page parameter above.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfAppointmentRequestReasonModel

Name	Type	Additional information
TotalItems	integer	None.
ItemsPerPage	integer	None.
CurrentPage	integer	None.
TotalPages	integer	None.
FirstRowOnPage	integer	None.
LastRowOnPage	integer	None.
Rows	Collection of AppointmentRequestReasonModel	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": "c8a0238d-9e74-4b31-948a-8086d0a85189",
      "Name": "sample string 2",
      "AppliesToNewPatients": true,
      "AppliesToExistentPatients": true,
      "SlotDuration": 5,
      "Active": true
    },
    {
      "Id": "c8a0238d-9e74-4b31-948a-8086d0a85189",
      "Name": "sample string 2",
      "AppliesToNewPatients": true,
      "AppliesToExistentPatients": true,
      "SlotDuration": 5,
      "Active": true
    }
  ]
}

application/xml, text/xml

Sample:

<ListModelOfAppointmentRequestReasonModelaKbTw8r2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequests">
    <d2p1:AppointmentRequestReasonModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AppliesToExistentPatients>true</d2p1:AppliesToExistentPatients>
      <d2p1:AppliesToNewPatients>true</d2p1:AppliesToNewPatients>
      <d2p1:Id>c8a0238d-9e74-4b31-948a-8086d0a85189</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SlotDuration>5</d2p1:SlotDuration>
    </d2p1:AppointmentRequestReasonModel>
    <d2p1:AppointmentRequestReasonModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AppliesToExistentPatients>true</d2p1:AppliesToExistentPatients>
      <d2p1:AppliesToNewPatients>true</d2p1:AppliesToNewPatients>
      <d2p1:Id>c8a0238d-9e74-4b31-948a-8086d0a85189</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SlotDuration>5</d2p1:SlotDuration>
    </d2p1:AppointmentRequestReasonModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfAppointmentRequestReasonModelaKbTw8r2>