GET api/PatientCommunications/search?status={status}&method={method}&creationDateOperator={creationDateOperator}&utcCreationDate1={utcCreationDate1}&utcCreationDate2={utcCreationDate2}&alreadySent={alreadySent}&appointmentExternalId={appointmentExternalId}&outgoing={outgoing}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient communications.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
status

Current Status of patient communication. Possible values: Succeed, Failed, Delayed, NotAcceptedByPatient and Retried

string

Default value is

method

Filter patient communications by the communicaiton method. Possible values: Email, Sms, Voice and MobileNotification

string

Default value is

creationDateOperator

Date creation a patient communication's comparison operators. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan, Contains, StartsWith

string

Default value is

utcCreationDate1

Date that is created a patient communication.

date

None.

utcCreationDate2

Second date that is created a patient communication.

date

None.

alreadySent

Filter patient communications on whether they are already sent or not.

boolean

None.

appointmentExternalId

Appointment's unique ID on integrating system.

string

Default value is

outgoing

Filter patient communications on whether they are outgoing or not.

boolean

None.

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

Returns a list of patient communications.

ListModelOfPatientCommunicationModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of PatientCommunicationModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "CommunicationId": "13f0ae14-64b3-42e0-b87f-9510c113fafc",
      "CreatedUtc": "sample string 2",
      "CommunicationMethod": "sample string 3",
      "CommunicationType": "sample string 4",
      "CommunicationScheduleId": "16c1b9ea-ef1e-4b42-aedb-dde30954e78d",
      "LanguageName": "sample string 5",
      "From": "sample string 6",
      "To": "sample string 7",
      "MessageTemplateId": "a21c8528-de4f-4459-8693-69c6e4c524e3",
      "TemplateName": "sample string 8",
      "MessageSubject": "sample string 9",
      "MessageVoiceHuman": "sample string 10",
      "MessageVoiceMachine": "sample string 11",
      "Outgoing": true,
      "LocationId": "f168de00-7873-414a-bcc6-a29193804e13",
      "LocationPhoneNumber": "sample string 13",
      "LocationName": "sample string 14",
      "TimeZoneId": "sample string 15",
      "TimeZoneDisplay": "sample string 16",
      "RecipientId": "859b0b24-1044-44f4-9f66-853b3339c516",
      "RecipientTitle": "sample string 17",
      "RecipientSuffix": "sample string 18",
      "RecipientExternalId": "sample string 19",
      "RecipientFirstName": "sample string 20",
      "RecipientLastName": "sample string 21",
      "RecipientMiddleName": "sample string 22",
      "CommunicationStatus": "sample string 23",
      "StatusNote": "sample string 24",
      "EyewearReadySetToStatusId": "6c1ace13-a885-4774-a5fa-440eb94d3f38",
      "TargetObjectId": "dcab1918-8971-4bc2-bd1b-99bc2ac65284",
      "TargetObjectExternalId": "sample string 25",
      "AlreadySent": true,
      "RecipientType": "sample string 27",
      "RecipientBirthday": "2021-06-21T04:09:21.1473495-04:00",
      "AppointmentExternalId": "sample string 28",
      "AppointmentStatusExternalId": "sample string 29",
      "TargetObjectIntegerId": 1
    },
    {
      "CommunicationId": "13f0ae14-64b3-42e0-b87f-9510c113fafc",
      "CreatedUtc": "sample string 2",
      "CommunicationMethod": "sample string 3",
      "CommunicationType": "sample string 4",
      "CommunicationScheduleId": "16c1b9ea-ef1e-4b42-aedb-dde30954e78d",
      "LanguageName": "sample string 5",
      "From": "sample string 6",
      "To": "sample string 7",
      "MessageTemplateId": "a21c8528-de4f-4459-8693-69c6e4c524e3",
      "TemplateName": "sample string 8",
      "MessageSubject": "sample string 9",
      "MessageVoiceHuman": "sample string 10",
      "MessageVoiceMachine": "sample string 11",
      "Outgoing": true,
      "LocationId": "f168de00-7873-414a-bcc6-a29193804e13",
      "LocationPhoneNumber": "sample string 13",
      "LocationName": "sample string 14",
      "TimeZoneId": "sample string 15",
      "TimeZoneDisplay": "sample string 16",
      "RecipientId": "859b0b24-1044-44f4-9f66-853b3339c516",
      "RecipientTitle": "sample string 17",
      "RecipientSuffix": "sample string 18",
      "RecipientExternalId": "sample string 19",
      "RecipientFirstName": "sample string 20",
      "RecipientLastName": "sample string 21",
      "RecipientMiddleName": "sample string 22",
      "CommunicationStatus": "sample string 23",
      "StatusNote": "sample string 24",
      "EyewearReadySetToStatusId": "6c1ace13-a885-4774-a5fa-440eb94d3f38",
      "TargetObjectId": "dcab1918-8971-4bc2-bd1b-99bc2ac65284",
      "TargetObjectExternalId": "sample string 25",
      "AlreadySent": true,
      "RecipientType": "sample string 27",
      "RecipientBirthday": "2021-06-21T04:09:21.1473495-04:00",
      "AppointmentExternalId": "sample string 28",
      "AppointmentStatusExternalId": "sample string 29",
      "TargetObjectIntegerId": 1
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfPatientCommunicationModelfXHitiuL 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.PatientCommunications">
    <d2p1:PatientCommunicationModel>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:AppointmentExternalId>sample string 28</d2p1:AppointmentExternalId>
      <d2p1:AppointmentStatusExternalId>sample string 29</d2p1:AppointmentStatusExternalId>
      <d2p1:CommunicationId>13f0ae14-64b3-42e0-b87f-9510c113fafc</d2p1:CommunicationId>
      <d2p1:CommunicationMethod>sample string 3</d2p1:CommunicationMethod>
      <d2p1:CommunicationScheduleId>16c1b9ea-ef1e-4b42-aedb-dde30954e78d</d2p1:CommunicationScheduleId>
      <d2p1:CommunicationStatus>sample string 23</d2p1:CommunicationStatus>
      <d2p1:CommunicationType>sample string 4</d2p1:CommunicationType>
      <d2p1:CreatedUtc>sample string 2</d2p1:CreatedUtc>
      <d2p1:EyewearReadySetToStatusId>6c1ace13-a885-4774-a5fa-440eb94d3f38</d2p1:EyewearReadySetToStatusId>
      <d2p1:From>sample string 6</d2p1:From>
      <d2p1:LanguageName>sample string 5</d2p1:LanguageName>
      <d2p1:LocationId>f168de00-7873-414a-bcc6-a29193804e13</d2p1:LocationId>
      <d2p1:LocationName>sample string 14</d2p1:LocationName>
      <d2p1:LocationPhoneNumber>sample string 13</d2p1:LocationPhoneNumber>
      <d2p1:MessageSubject>sample string 9</d2p1:MessageSubject>
      <d2p1:MessageTemplateId>a21c8528-de4f-4459-8693-69c6e4c524e3</d2p1:MessageTemplateId>
      <d2p1:MessageVoiceHuman>sample string 10</d2p1:MessageVoiceHuman>
      <d2p1:MessageVoiceMachine>sample string 11</d2p1:MessageVoiceMachine>
      <d2p1:Outgoing>true</d2p1:Outgoing>
      <d2p1:RecipientBirthday>2021-06-21T04:09:21.1473495-04:00</d2p1:RecipientBirthday>
      <d2p1:RecipientExternalId>sample string 19</d2p1:RecipientExternalId>
      <d2p1:RecipientFirstName>sample string 20</d2p1:RecipientFirstName>
      <d2p1:RecipientId>859b0b24-1044-44f4-9f66-853b3339c516</d2p1:RecipientId>
      <d2p1:RecipientLastName>sample string 21</d2p1:RecipientLastName>
      <d2p1:RecipientMiddleName>sample string 22</d2p1:RecipientMiddleName>
      <d2p1:RecipientSuffix>sample string 18</d2p1:RecipientSuffix>
      <d2p1:RecipientTitle>sample string 17</d2p1:RecipientTitle>
      <d2p1:RecipientType>sample string 27</d2p1:RecipientType>
      <d2p1:StatusNote>sample string 24</d2p1:StatusNote>
      <d2p1:TargetObjectExternalId>sample string 25</d2p1:TargetObjectExternalId>
      <d2p1:TargetObjectId>dcab1918-8971-4bc2-bd1b-99bc2ac65284</d2p1:TargetObjectId>
      <d2p1:TargetObjectIntegerId>1</d2p1:TargetObjectIntegerId>
      <d2p1:TemplateName>sample string 8</d2p1:TemplateName>
      <d2p1:TimeZoneDisplay>sample string 16</d2p1:TimeZoneDisplay>
      <d2p1:TimeZoneId>sample string 15</d2p1:TimeZoneId>
      <d2p1:To>sample string 7</d2p1:To>
    </d2p1:PatientCommunicationModel>
    <d2p1:PatientCommunicationModel>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:AppointmentExternalId>sample string 28</d2p1:AppointmentExternalId>
      <d2p1:AppointmentStatusExternalId>sample string 29</d2p1:AppointmentStatusExternalId>
      <d2p1:CommunicationId>13f0ae14-64b3-42e0-b87f-9510c113fafc</d2p1:CommunicationId>
      <d2p1:CommunicationMethod>sample string 3</d2p1:CommunicationMethod>
      <d2p1:CommunicationScheduleId>16c1b9ea-ef1e-4b42-aedb-dde30954e78d</d2p1:CommunicationScheduleId>
      <d2p1:CommunicationStatus>sample string 23</d2p1:CommunicationStatus>
      <d2p1:CommunicationType>sample string 4</d2p1:CommunicationType>
      <d2p1:CreatedUtc>sample string 2</d2p1:CreatedUtc>
      <d2p1:EyewearReadySetToStatusId>6c1ace13-a885-4774-a5fa-440eb94d3f38</d2p1:EyewearReadySetToStatusId>
      <d2p1:From>sample string 6</d2p1:From>
      <d2p1:LanguageName>sample string 5</d2p1:LanguageName>
      <d2p1:LocationId>f168de00-7873-414a-bcc6-a29193804e13</d2p1:LocationId>
      <d2p1:LocationName>sample string 14</d2p1:LocationName>
      <d2p1:LocationPhoneNumber>sample string 13</d2p1:LocationPhoneNumber>
      <d2p1:MessageSubject>sample string 9</d2p1:MessageSubject>
      <d2p1:MessageTemplateId>a21c8528-de4f-4459-8693-69c6e4c524e3</d2p1:MessageTemplateId>
      <d2p1:MessageVoiceHuman>sample string 10</d2p1:MessageVoiceHuman>
      <d2p1:MessageVoiceMachine>sample string 11</d2p1:MessageVoiceMachine>
      <d2p1:Outgoing>true</d2p1:Outgoing>
      <d2p1:RecipientBirthday>2021-06-21T04:09:21.1473495-04:00</d2p1:RecipientBirthday>
      <d2p1:RecipientExternalId>sample string 19</d2p1:RecipientExternalId>
      <d2p1:RecipientFirstName>sample string 20</d2p1:RecipientFirstName>
      <d2p1:RecipientId>859b0b24-1044-44f4-9f66-853b3339c516</d2p1:RecipientId>
      <d2p1:RecipientLastName>sample string 21</d2p1:RecipientLastName>
      <d2p1:RecipientMiddleName>sample string 22</d2p1:RecipientMiddleName>
      <d2p1:RecipientSuffix>sample string 18</d2p1:RecipientSuffix>
      <d2p1:RecipientTitle>sample string 17</d2p1:RecipientTitle>
      <d2p1:RecipientType>sample string 27</d2p1:RecipientType>
      <d2p1:StatusNote>sample string 24</d2p1:StatusNote>
      <d2p1:TargetObjectExternalId>sample string 25</d2p1:TargetObjectExternalId>
      <d2p1:TargetObjectId>dcab1918-8971-4bc2-bd1b-99bc2ac65284</d2p1:TargetObjectId>
      <d2p1:TargetObjectIntegerId>1</d2p1:TargetObjectIntegerId>
      <d2p1:TemplateName>sample string 8</d2p1:TemplateName>
      <d2p1:TimeZoneDisplay>sample string 16</d2p1:TimeZoneDisplay>
      <d2p1:TimeZoneId>sample string 15</d2p1:TimeZoneId>
      <d2p1:To>sample string 7</d2p1:To>
    </d2p1:PatientCommunicationModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientCommunicationModelfXHitiuL>