GET api/AccountSettings?accountNumber={accountNumber}&clientType={clientType}

Returns the settings of an account.

Request Information

URI Parameters

Name	Description	Type	Additional information
accountNumber	Account number	string	Required
clientType	Client type. Possible values: Portal, Kiosk.	string	Default value is Kiosk

Body Parameters

None.

Response Information

Resource Description

AccountSettingsModel

Name	Description	Type	Additional information
AccountName	Name of the customer account.	string	None.
AccountKey	Key of the customer account.	string	None.
AppointmentIntegrationType	Appointment Integration Type of the customer account.	string	None.
LogoPath	Logo Path of the customer account	string	None.
LogoText	Logo Text of the customer account.	string	None.
PartnerId	PartnerId of the customer account.	globally unique identifier	None.
PartnerName	Partner Name of the customer account.	string	None.
CommunicationsActive	Indicates whether the communications for the account module is active or not.	boolean	None.
SecureMessagesActive	Indicates whether the secure messages for the account module is active or not.	boolean	None.
DirectMessagesActive	Indicates whether the direct messages for the account module is active or not.	boolean	None.
FormsActive	Indicates whether the forms for the account module is active or not.	boolean	None.
SurveysActive	Indicates whether the surveys for the account module is active or not.	boolean	None.
MeaningfulUseActive	Indicates whether the meaningful use for the account module is active or not.	boolean	None.
CdasActive	Indicates whether the cdas for the account module is active or not.	boolean	None.
OnlineAppointmentsActive	Indicates whether the online appointments for the account module is active or not.	boolean	None.
AllowAppointmentRequestWithoutRegister	Indicates whether the online appointments requests are allowed without register or not.	boolean	None.
OrdersActive	Indicates whether the orders for the account module is active or not.	boolean	None.
VideoCallActive	Indicates whether the video call for the account module is active or not.	boolean	None.
MedicationRefillsActive	Indicates whether the medication refills for the account module is active or not.	boolean	None.
PatientEducationActive	Indicates whether the patient education for the account module is active or not.	boolean	None.
ExternalHealthInformationLinkActive	Indicates whether the external health information Link for the account module is active or not.	boolean	None.
PatientSharedFilesActive	Indicates whether the patient shared files for the account module is active or not.	boolean	None.
RecallActive	Indicates whether the recall for the account module is active or not.	boolean	None.
PatientApplicationsActive	Indicates whether the patient applications for the account module is active or not.	boolean	None.
PghdActive	Indicates whether the PGHD module is active or not.	boolean	None.
BillPayActive	Indicates whether the bill pay (make payment) module is active or not.	boolean	None.
FormFileActive	Indicates whether the form file (Signed consent forms) module is active or not.	boolean	None.
ContactLensPrescriptionActive	Indicates whether contact lens prescriptions module is active or not.	boolean	None.
ContactLensOrderActive	Indicates whether contact lens orders module is active or not.	boolean	None.
GlassesPrescriptionActive	Indicates whether glasses prescriptions module is active or not.	boolean	None.
MedicationRefillRequestType	Medication refill request types of the customer account.	string	None.
CommunicationTypes	Communication Types of the customer account.	Collection of AccountCommunicationTypes	None.
HealthInformationSettings	List of Patient health information modules.	Collection of HealthInformationSettingsModel	None.
KioskAppSessionTimeout	Kiosk application session timeout (minutes).	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AccountName": "sample string 1",
  "AccountKey": "sample string 2",
  "AppointmentIntegrationType": "sample string 3",
  "LogoPath": "sample string 4",
  "LogoText": "sample string 5",
  "PartnerId": "c3a7c8f2-bc9b-41d2-9d9f-149ce373ca84",
  "PartnerName": "sample string 7",
  "CommunicationsActive": true,
  "SecureMessagesActive": true,
  "DirectMessagesActive": true,
  "FormsActive": true,
  "SurveysActive": true,
  "MeaningfulUseActive": true,
  "CdasActive": true,
  "OnlineAppointmentsActive": true,
  "AllowAppointmentRequestWithoutRegister": true,
  "OrdersActive": true,
  "VideoCallActive": true,
  "MedicationRefillsActive": true,
  "PatientEducationActive": true,
  "ExternalHealthInformationLinkActive": true,
  "PatientSharedFilesActive": true,
  "RecallActive": true,
  "PatientApplicationsActive": true,
  "PghdActive": true,
  "BillPayActive": true,
  "FormFileActive": true,
  "ContactLensPrescriptionActive": true,
  "ContactLensOrderActive": true,
  "GlassesPrescriptionActive": true,
  "MedicationRefillRequestType": "sample string 31",
  "CommunicationTypes": [
    {
      "CommunicationTypeKey": "sample string 1",
      "IsSelected": true
    },
    {
      "CommunicationTypeKey": "sample string 1",
      "IsSelected": true
    }
  ],
  "HealthInformationSettings": [
    {
      "Key": "sample string 1",
      "Alias": "sample string 2",
      "Name": "sample string 3",
      "Active": true
    },
    {
      "Key": "sample string 1",
      "Alias": "sample string 2",
      "Name": "sample string 3",
      "Active": true
    }
  ],
  "KioskAppSessionTimeout": 32
}

application/xml, text/xml

Sample:

<AccountSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AccountSettings">
  <AccountKey>sample string 2</AccountKey>
  <AccountName>sample string 1</AccountName>
  <AllowAppointmentRequestWithoutRegister>true</AllowAppointmentRequestWithoutRegister>
  <AppointmentIntegrationType>sample string 3</AppointmentIntegrationType>
  <BillPayActive>true</BillPayActive>
  <CdasActive>true</CdasActive>
  <CommunicationTypes>
    <AccountCommunicationTypes>
      <CommunicationTypeKey>sample string 1</CommunicationTypeKey>
      <IsSelected>true</IsSelected>
    </AccountCommunicationTypes>
    <AccountCommunicationTypes>
      <CommunicationTypeKey>sample string 1</CommunicationTypeKey>
      <IsSelected>true</IsSelected>
    </AccountCommunicationTypes>
  </CommunicationTypes>
  <CommunicationsActive>true</CommunicationsActive>
  <ContactLensOrderActive>true</ContactLensOrderActive>
  <ContactLensPrescriptionActive>true</ContactLensPrescriptionActive>
  <DirectMessagesActive>true</DirectMessagesActive>
  <ExternalHealthInformationLinkActive>true</ExternalHealthInformationLinkActive>
  <FormFileActive>true</FormFileActive>
  <FormsActive>true</FormsActive>
  <GlassesPrescriptionActive>true</GlassesPrescriptionActive>
  <HealthInformationSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthInformation">
    <d2p1:HealthInformationSettingsModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Alias>sample string 2</d2p1:Alias>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:HealthInformationSettingsModel>
    <d2p1:HealthInformationSettingsModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Alias>sample string 2</d2p1:Alias>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:HealthInformationSettingsModel>
  </HealthInformationSettings>
  <KioskAppSessionTimeout>32</KioskAppSessionTimeout>
  <LogoPath>sample string 4</LogoPath>
  <LogoText>sample string 5</LogoText>
  <MeaningfulUseActive>true</MeaningfulUseActive>
  <MedicationRefillRequestType>sample string 31</MedicationRefillRequestType>
  <MedicationRefillsActive>true</MedicationRefillsActive>
  <OnlineAppointmentsActive>true</OnlineAppointmentsActive>
  <OrdersActive>true</OrdersActive>
  <PartnerId>c3a7c8f2-bc9b-41d2-9d9f-149ce373ca84</PartnerId>
  <PartnerName>sample string 7</PartnerName>
  <PatientApplicationsActive>true</PatientApplicationsActive>
  <PatientEducationActive>true</PatientEducationActive>
  <PatientSharedFilesActive>true</PatientSharedFilesActive>
  <PghdActive>true</PghdActive>
  <RecallActive>true</RecallActive>
  <SecureMessagesActive>true</SecureMessagesActive>
  <SurveysActive>true</SurveysActive>
  <VideoCallActive>true</VideoCallActive>
</AccountSettingsModel>