GET api/AlertisApi/GetSettings?kioskName={kioskName}

Request Information

URI Parameters

Name	Description	Type	Additional information
kioskName		string	Required

Body Parameters

None.

Response Information

Resource Description

SettingsDTO

Name	Type	Additional information
Theme	ThemeDTO	None.
SafetyRegulationsPdfUrl	string	None.
PackageDeliveryEnabled	boolean	None.
HomeScreenMessageEnabled	boolean	None.
EscapePlanFlowEnabled	boolean	None.
SafetyRegulationsEnabled	boolean	None.
QrCodeEnabled	boolean	None.
ShowVisitorInfoPage	ShowVisitorInfoPage	None.
VisitorInfoPhoneRequired	boolean	None.
VisitorInfoMobileRequired	boolean	None.
VisitorInfoLicensePlateRequired	boolean	None.
ActivityTimeoutDuration	integer	None.
TimeoutReturnToHomeDuration	integer	None.
ContractorEnabled	boolean	None.
InterimEnabled	boolean	None.
VisitorInfoShowPhoneInput	boolean	None.
VisitorInfoShowMobileInput	boolean	None.
VisitorInfoShowLicensePlateInput	boolean	None.
BadgeSafetyRegulationsEnabled	boolean	None.
IsCloudHosted	boolean	None.
LanguagePickerStartPage	boolean	None.
DisableIHaveAnAppointment	boolean	None.
DisableIDontHaveAnAppointment	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Theme": {
    "PrimaryColor": "sample string 1",
    "SecondaryColor": "sample string 2",
    "MessageBackgroundColor": "sample string 3",
    "MessageColor": "sample string 4",
    "TileBackgroundColor": "sample string 5",
    "TileColor": "sample string 6",
    "ErrorColor": "sample string 7",
    "LogoUrl": "sample string 8",
    "TextColor": "sample string 9",
    "TitleColor": "sample string 10",
    "LabelLogoUrl": "sample string 11"
  },
  "SafetyRegulationsPdfUrl": "sample string 1",
  "PackageDeliveryEnabled": true,
  "HomeScreenMessageEnabled": true,
  "EscapePlanFlowEnabled": true,
  "SafetyRegulationsEnabled": true,
  "QrCodeEnabled": true,
  "ShowVisitorInfoPage": "Always",
  "VisitorInfoPhoneRequired": true,
  "VisitorInfoMobileRequired": true,
  "VisitorInfoLicensePlateRequired": true,
  "ActivityTimeoutDuration": 10,
  "TimeoutReturnToHomeDuration": 11,
  "ContractorEnabled": true,
  "InterimEnabled": true,
  "VisitorInfoShowPhoneInput": true,
  "VisitorInfoShowMobileInput": true,
  "VisitorInfoShowLicensePlateInput": true,
  "BadgeSafetyRegulationsEnabled": true,
  "IsCloudHosted": true,
  "LanguagePickerStartPage": true,
  "DisableIHaveAnAppointment": true,
  "DisableIDontHaveAnAppointment": true
}

application/xml, text/xml

Sample:

<SettingsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alertis.Model.DTO">
  <ActivityTimeoutDuration>10</ActivityTimeoutDuration>
  <BadgeSafetyRegulationsEnabled>true</BadgeSafetyRegulationsEnabled>
  <ContractorEnabled>true</ContractorEnabled>
  <DisableIDontHaveAnAppointment>true</DisableIDontHaveAnAppointment>
  <DisableIHaveAnAppointment>true</DisableIHaveAnAppointment>
  <EscapePlanFlowEnabled>true</EscapePlanFlowEnabled>
  <HomeScreenMessageEnabled>true</HomeScreenMessageEnabled>
  <InterimEnabled>true</InterimEnabled>
  <IsCloudHosted>true</IsCloudHosted>
  <LanguagePickerStartPage>true</LanguagePickerStartPage>
  <PackageDeliveryEnabled>true</PackageDeliveryEnabled>
  <QrCodeEnabled>true</QrCodeEnabled>
  <SafetyRegulationsEnabled>true</SafetyRegulationsEnabled>
  <SafetyRegulationsPdfUrl>sample string 1</SafetyRegulationsPdfUrl>
  <ShowVisitorInfoPage>Always</ShowVisitorInfoPage>
  <Theme>
    <ErrorColor>sample string 7</ErrorColor>
    <LabelLogoUrl>sample string 11</LabelLogoUrl>
    <LogoUrl>sample string 8</LogoUrl>
    <MessageBackgroundColor>sample string 3</MessageBackgroundColor>
    <MessageColor>sample string 4</MessageColor>
    <PrimaryColor>sample string 1</PrimaryColor>
    <SecondaryColor>sample string 2</SecondaryColor>
    <TextColor>sample string 9</TextColor>
    <TileBackgroundColor>sample string 5</TileBackgroundColor>
    <TileColor>sample string 6</TileColor>
    <TitleColor>sample string 10</TitleColor>
  </Theme>
  <TimeoutReturnToHomeDuration>11</TimeoutReturnToHomeDuration>
  <VisitorInfoLicensePlateRequired>true</VisitorInfoLicensePlateRequired>
  <VisitorInfoMobileRequired>true</VisitorInfoMobileRequired>
  <VisitorInfoPhoneRequired>true</VisitorInfoPhoneRequired>
  <VisitorInfoShowLicensePlateInput>true</VisitorInfoShowLicensePlateInput>
  <VisitorInfoShowMobileInput>true</VisitorInfoShowMobileInput>
  <VisitorInfoShowPhoneInput>true</VisitorInfoShowPhoneInput>
</SettingsDTO>