GET api/CommunicationPreferences

Returns the communication preferences of the current patient.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CommunicationPreferencesModel

Name	Description	Type	Additional information
UseDifferentEmailAndPhoneForCommunications	Indicates if different email and phone will be used for communication.	boolean	None.
EmailAddress	Email address.	string	None.
EmailAddressOnPatientRecord	Email address on patient record.	string	None.
AllowEmailReminders	Indicates whether the patient agrees to receive email reminders.	boolean	None.
AllowEmailPromotions	Indicates whether the patient agrees to receive promotional messages by email.	boolean	None.
MobilePhoneNumber	Mobile phone number.	string	None.
MobilePhoneNumberOnPatientRecord	Mobile phone number on patient record.	string	None.
AllowSmsReminders	Indicates whether the patient agrees to receive SMS reminders.	boolean	None.
AllowSmsPromotions	Indicates whether the patient agrees to receive promotional messages by SMS.	boolean	None.
PrimaryPhoneNumber	Primary phone number.	string	None.
PrimaryPhoneNumberOnPatientRecord	Primary phone number on patient record.	string	None.
AllowVoiceReminders	Indicates whether the patient agrees to receive voice reminders.	boolean	None.
AllowVoicePromotions	Indicates whether the patient agrees to receive promotional calls.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "UseDifferentEmailAndPhoneForCommunications": true,
  "EmailAddress": "sample string 2",
  "EmailAddressOnPatientRecord": "sample string 3",
  "AllowEmailReminders": true,
  "AllowEmailPromotions": true,
  "MobilePhoneNumber": "sample string 6",
  "MobilePhoneNumberOnPatientRecord": "sample string 7",
  "AllowSmsReminders": true,
  "AllowSmsPromotions": true,
  "PrimaryPhoneNumber": "sample string 10",
  "PrimaryPhoneNumberOnPatientRecord": "sample string 11",
  "AllowVoiceReminders": true,
  "AllowVoicePromotions": true
}

application/xml, text/xml

Sample:

<CommunicationPreferencesModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientProfile">
  <AllowEmailPromotions>true</AllowEmailPromotions>
  <AllowEmailReminders>true</AllowEmailReminders>
  <AllowSmsPromotions>true</AllowSmsPromotions>
  <AllowSmsReminders>true</AllowSmsReminders>
  <AllowVoicePromotions>true</AllowVoicePromotions>
  <AllowVoiceReminders>true</AllowVoiceReminders>
  <EmailAddress>sample string 2</EmailAddress>
  <EmailAddressOnPatientRecord>sample string 3</EmailAddressOnPatientRecord>
  <MobilePhoneNumber>sample string 6</MobilePhoneNumber>
  <MobilePhoneNumberOnPatientRecord>sample string 7</MobilePhoneNumberOnPatientRecord>
  <PrimaryPhoneNumber>sample string 10</PrimaryPhoneNumber>
  <PrimaryPhoneNumberOnPatientRecord>sample string 11</PrimaryPhoneNumberOnPatientRecord>
  <UseDifferentEmailAndPhoneForCommunications>true</UseDifferentEmailAndPhoneForCommunications>
</CommunicationPreferencesModel>