GET api/Public/InstitutionSettings

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
TimeZone	string	None.
CalendarStartTime	string	None.
CalendarEndTime	string	None.
CalendarShowWeekends	boolean	None.
CalendarFirstDayOfTheWeekOffset	integer	None.
WeekendDays	Collection of integer	None.
SettingsCacheExpiryMinutes	integer	None.
ActivityManagerActive	boolean	None.
CalendarAgendaViewShowDuration	boolean	None.
CalendarDefaultViewType	string	None.
VisibleStatuses	Collection of ActivityManagerStatus	None.
CalendarStartTimeOffset	integer	None.
CalendarEndTimeOffset	integer	None.
PersonalTimetablesFeature	string	None.
ObjectTimetablesFeature	string	None.
AnyGuestTimetablesEnabled	boolean	None.
Title	TextDesign	None.
SubTitle	TextDesign	None.
ExportExcelDisabled	boolean	None.
TimezoneSelectorEnabled	boolean	None.
ClientId	string	None.
InstitutionIdentity	string	None.
ExtraDatasets	string	None.
LogOnMessageEnabled	boolean	None.
LogOnMessage	string	None.
Version	string	None.
Language	string	None.
BaseUrl	string	None.
RedirectUrl	string	None.
EntityId	string	None.
WelcomeMessage	string	None.
HideWelcomeMessage	boolean	None.
ApplicationName	string	None.
Translations	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TimeZone": "sample string 1",
  "CalendarStartTime": "sample string 2",
  "CalendarEndTime": "sample string 3",
  "CalendarShowWeekends": true,
  "CalendarFirstDayOfTheWeekOffset": 5,
  "WeekendDays": [
    1,
    2
  ],
  "SettingsCacheExpiryMinutes": 6,
  "ActivityManagerActive": true,
  "CalendarAgendaViewShowDuration": true,
  "CalendarDefaultViewType": "sample string 9",
  "VisibleStatuses": [
    {
      "Identity": "28b252dd-b71a-456c-a9cc-21cf13ae037e",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SendNotifications": true,
      "BackgroundColor": "sample string 5",
      "TextColor": "sample string 6",
      "UseColor": true,
      "Rank": 8,
      "IsReadOnly": true
    },
    {
      "Identity": "28b252dd-b71a-456c-a9cc-21cf13ae037e",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SendNotifications": true,
      "BackgroundColor": "sample string 5",
      "TextColor": "sample string 6",
      "UseColor": true,
      "Rank": 8,
      "IsReadOnly": true
    }
  ],
  "CalendarStartTimeOffset": 10,
  "CalendarEndTimeOffset": 11,
  "PersonalTimetablesFeature": "sample string 12",
  "ObjectTimetablesFeature": "sample string 13",
  "AnyGuestTimetablesEnabled": true,
  "Title": {
    "Long": "sample string 1",
    "Short": "sample string 2",
    "FontSizeLong": "sample string 3",
    "FontSizeShort": "sample string 4"
  },
  "SubTitle": {
    "Long": "sample string 1",
    "Short": "sample string 2",
    "FontSizeLong": "sample string 3",
    "FontSizeShort": "sample string 4"
  },
  "ExportExcelDisabled": true,
  "TimezoneSelectorEnabled": true,
  "ClientId": "sample string 17",
  "InstitutionIdentity": "sample string 18",
  "ExtraDatasets": "sample string 19",
  "LogOnMessageEnabled": true,
  "LogOnMessage": "sample string 21",
  "Version": "sample string 22",
  "Language": "sample string 23",
  "BaseUrl": "sample string 24",
  "RedirectUrl": "sample string 25",
  "EntityId": "sample string 26",
  "WelcomeMessage": "sample string 27",
  "HideWelcomeMessage": true,
  "ApplicationName": "sample string 29",
  "Translations": "sample string 30"
}

application/xml, text/xml

Sample:

<PublicInstitutionSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <ApplicationName>sample string 29</ApplicationName>
  <BaseUrl>sample string 24</BaseUrl>
  <ClientId>sample string 17</ClientId>
  <EntityId>sample string 26</EntityId>
  <ExtraDatasets>sample string 19</ExtraDatasets>
  <HideWelcomeMessage>true</HideWelcomeMessage>
  <InstitutionIdentity>sample string 18</InstitutionIdentity>
  <Language>sample string 23</Language>
  <LogOnMessage>sample string 21</LogOnMessage>
  <LogOnMessageEnabled>true</LogOnMessageEnabled>
  <RedirectUrl>sample string 25</RedirectUrl>
  <Translations>sample string 30</Translations>
  <Version>sample string 22</Version>
  <WelcomeMessage>sample string 27</WelcomeMessage>
  <ActivityManagerActive>true</ActivityManagerActive>
  <AnyGuestTimetablesEnabled>true</AnyGuestTimetablesEnabled>
  <CalendarAgendaViewShowDuration>true</CalendarAgendaViewShowDuration>
  <CalendarDefaultViewType>sample string 9</CalendarDefaultViewType>
  <CalendarEndTime>sample string 3</CalendarEndTime>
  <CalendarEndTimeOffset>11</CalendarEndTimeOffset>
  <CalendarFirstDayOfTheWeekOffset>5</CalendarFirstDayOfTheWeekOffset>
  <CalendarShowWeekends>true</CalendarShowWeekends>
  <CalendarStartTime>sample string 2</CalendarStartTime>
  <CalendarStartTimeOffset>10</CalendarStartTimeOffset>
  <ExportExcelDisabled>true</ExportExcelDisabled>
  <ObjectTimetablesFeature>sample string 13</ObjectTimetablesFeature>
  <PersonalTimetablesFeature>sample string 12</PersonalTimetablesFeature>
  <SettingsCacheExpiryMinutes>6</SettingsCacheExpiryMinutes>
  <SubTitle>
    <FontSizeLong>sample string 3</FontSizeLong>
    <FontSizeShort>sample string 4</FontSizeShort>
    <Long>sample string 1</Long>
    <Short>sample string 2</Short>
  </SubTitle>
  <TimeZone>sample string 1</TimeZone>
  <TimezoneSelectorEnabled>true</TimezoneSelectorEnabled>
  <Title>
    <FontSizeLong>sample string 3</FontSizeLong>
    <FontSizeShort>sample string 4</FontSizeShort>
    <Long>sample string 1</Long>
    <Short>sample string 2</Short>
  </Title>
  <VisibleStatuses>
    <ActivityManagerStatus>
      <BackgroundColor>sample string 5</BackgroundColor>
      <Description>sample string 3</Description>
      <Identity>28b252dd-b71a-456c-a9cc-21cf13ae037e</Identity>
      <IsReadOnly>true</IsReadOnly>
      <Name>sample string 2</Name>
      <Rank>8</Rank>
      <SendNotifications>true</SendNotifications>
      <TextColor>sample string 6</TextColor>
      <UseColor>true</UseColor>
    </ActivityManagerStatus>
    <ActivityManagerStatus>
      <BackgroundColor>sample string 5</BackgroundColor>
      <Description>sample string 3</Description>
      <Identity>28b252dd-b71a-456c-a9cc-21cf13ae037e</Identity>
      <IsReadOnly>true</IsReadOnly>
      <Name>sample string 2</Name>
      <Rank>8</Rank>
      <SendNotifications>true</SendNotifications>
      <TextColor>sample string 6</TextColor>
      <UseColor>true</UseColor>
    </ActivityManagerStatus>
  </VisibleStatuses>
  <WeekendDays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </WeekendDays>
</PublicInstitutionSettings>