GET api/v2.0/System/GetMobileAppSettings

Get the mobile app settings configured by a tenant's administrator. If not set, values default to those of the main microsite.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

This returns the settings to be used for mobile app display

MobileAppSettingsModel
NameDescriptionTypeAdditional information
MobileSiteName

The name to be displayed in the mobile app.

string

None.

MobilePrimaryColor

Hex color value to be used as the primary color in the mobile app.

string

None.

MobileColorOnPrimary

Hex color value to be used for text and symbols located on the primary color in the mobile app.

string

None.

MobileNotificationColor

Hex color value to be used as the notification color in the mobile app.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MobileSiteName": "sample string 1",
  "MobilePrimaryColor": "sample string 2",
  "MobileColorOnPrimary": "sample string 3",
  "MobileNotificationColor": "sample string 4"
}

application/xml, text/xml

Sample:
<MobileAppSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.SystemSettings" />