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

Returns the health information configuration settings of the given 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

Collection of HealthInformationSettingsModel

Name	Description	Type	Additional information
Key	Unique key of health information setting.	string	None.
Alias	Alias of the health information setting.	string	None.
Name	Name of the health information setting.	string	None.
Active	Indicates if patient health information module is active or not.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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
  }
]

application/xml, text/xml

Sample:

<ArrayOfHealthInformationSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthInformation">
  <HealthInformationSettingsModel>
    <Active>true</Active>
    <Alias>sample string 2</Alias>
    <Key>sample string 1</Key>
    <Name>sample string 3</Name>
  </HealthInformationSettingsModel>
  <HealthInformationSettingsModel>
    <Active>true</Active>
    <Alias>sample string 2</Alias>
    <Key>sample string 1</Key>
    <Name>sample string 3</Name>
  </HealthInformationSettingsModel>
</ArrayOfHealthInformationSettingsModel>