GET api/appointmentcancelrequests/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Gets a list of appointment cancellation requests.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
alreadySent

Filters the list of cancellation requests based on whether they have been sent to the integrating system or not.

 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 (search results are paginated).

 integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfAppointmentCancelRequestModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.
ItemsPerPage

integer

None.
CurrentPage

integer

None.
TotalPages

integer

None.
FirstRowOnPage

integer

None.
LastRowOnPage

integer

None.
Rows

Collection of AppointmentCancelRequestModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "appointmentCancelRequestID": "29940f0d-bc47-4183-9faf-635d24fe6228",
      "cancelReason": "sample string 2",
      "appointmentExternalID": "sample string 3"
    },
    {
      "appointmentCancelRequestID": "29940f0d-bc47-4183-9faf-635d24fe6228",
      "cancelReason": "sample string 2",
      "appointmentExternalID": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<ListModelOfAppointmentCancelRequestModelYyfsb76T xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.AppointmentCancelRequests">
    <d2p1:AppointmentCancelRequestModel>
      <d2p1:AppointmentCancelRequestID>29940f0d-bc47-4183-9faf-635d24fe6228</d2p1:AppointmentCancelRequestID>
      <d2p1:AppointmentExternalID>sample string 3</d2p1:AppointmentExternalID>
      <d2p1:CancelReason>sample string 2</d2p1:CancelReason>
    </d2p1:AppointmentCancelRequestModel>
    <d2p1:AppointmentCancelRequestModel>
      <d2p1:AppointmentCancelRequestID>29940f0d-bc47-4183-9faf-635d24fe6228</d2p1:AppointmentCancelRequestID>
      <d2p1:AppointmentExternalID>sample string 3</d2p1:AppointmentExternalID>
      <d2p1:CancelReason>sample string 2</d2p1:CancelReason>
    </d2p1:AppointmentCancelRequestModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfAppointmentCancelRequestModelYyfsb76T>