GET api/InstitutionSettings

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
Name	string	None.
Culture	string	None.
TimeZone	string	None.
Identity	globally unique identifier	None.
SystemMode	string	None.
SingleLogoutMode	integer	None.
NotificationWindow	integer	None.
ClientId	string	None.
AutoApprove	boolean	None.
ResourceCacheMinutes	integer	None.
MaxOccurrences	integer	None.
WeekendDays	Collection of integer	None.
ResourcesListInitialLoadSize	integer	None.
ResourcesListAdditionalLoadSize	integer	None.
WebsiteConfig	WebsiteConfig	None.
ReferenceFormat	string	None.
IsLite	boolean	None.
DetailedUnavailabilityBookingDisplay	string	None.
BookingHistoryAdminOnly	boolean	None.
AttachmentFileTypes	AttachmentFileTypes	None.
ExternalSystemFormFieldDelimeter	string	None.
ExternalSystemFormFieldTemplate	string	None.
AuditFormFieldDelimeter	string	None.
AuditFormFieldTemplate	string	None.
MaxFileSizeKB	integer	None.
CalendarShowWeekends	boolean	None.
CalendarFirstDayOfTheWeekOffset	integer	None.
CalendarStartTimeOffset	integer	None.
CalendarEndTimeOffset	integer	None.
CalendarAgendaViewShowDuration	boolean	None.
CalendarDefaultViewType	string	None.
CalendarSmallViewType	string	None.
HelpPageUrl	string	None.
ContactPageUrl	string	None.
IconsTemplateUrl	string	None.
EnableBobo	boolean	None.
EnableBase	boolean	None.
DisableRecurring	boolean	None.
DisableEditing	boolean	None.
AllowCancelPastBookings	boolean	None.
AllowCancelPastBookingsAdmin	boolean	None.
CustomFieldsLSE	boolean	None.
CustomFieldsCUHK	boolean	None.
BookingRequestAlternativeRedirect	boolean	None.
ShowAllCustomUserGroups	boolean	None.
CalendarNavigationLoadDelay	integer	None.
CalendarShowBookings	boolean	None.
FindTimetableShowBookings	boolean	None.
ActivityManagerHideBookings	boolean	None.
ActivityManagerActive	boolean	None.
ActivityManagerActiveToggleDate	string	None.
ActivityManagerSelectableCategories	string	None.
ActivityManagerStatusShowCount	boolean	None.
ActivityManagerStatusShowGraph	boolean	None.
FindTimetableResultsPerPage	integer	None.
FindTimetablePageDisable	boolean	None.
FindTimetableSelectableCategories	string	None.
FindTimetableDefaultCategory	string	None.
NotificationsPageDisable	boolean	None.
ActivityManagerMaxNoOfEvents	integer	None.
ActivityManagerMaxNoOfOccurrences	integer	None.
ActivityManagerMinObjectSelections	integer	None.
IcalExpandPopupByDefault	boolean	None.
IcalGoogle	string	None.
IcalHideCalendarButtons	boolean	None.
IcalOutlookOnline	string	None.
IcalOffice365	string	None.
IcalYahoo	string	None.
IcalUseDefaultUserGroup	boolean	None.
IcalShowBookings	boolean	None.
IcalShowBookingsToggleDateUtcManualEntry	string	None.
MaxUpdate	integer	None.
ProcessPublishStatusDisabled	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Culture": "sample string 2",
  "TimeZone": "sample string 3",
  "Identity": "e787b85a-6b8e-45c5-94df-c44416ca11b5",
  "SystemMode": "sample string 5",
  "SingleLogoutMode": 6,
  "NotificationWindow": 7,
  "ClientId": "sample string 8",
  "AutoApprove": true,
  "ResourceCacheMinutes": 10,
  "MaxOccurrences": 11,
  "WeekendDays": [
    1,
    2
  ],
  "ResourcesListInitialLoadSize": 12,
  "ResourcesListAdditionalLoadSize": 13,
  "WebsiteConfig": {
    "ClientId": "sample string 1",
    "ExtraDatasets": "sample string 2",
    "LogOnMessageEnabled": true,
    "LogOnMessage": "sample string 4",
    "Version": "sample string 5",
    "Language": "sample string 6",
    "BaseUrl": "sample string 7",
    "RedirectUrl": "sample string 8",
    "EntityId": "sample string 9",
    "WelcomeMessage": "sample string 10",
    "ApplicationName": "sample string 11",
    "Translations": "sample string 12"
  },
  "ReferenceFormat": "sample string 14",
  "IsLite": true,
  "DetailedUnavailabilityBookingDisplay": "sample string 16",
  "BookingHistoryAdminOnly": true,
  "AttachmentFileTypes": {
    "Image": "sample string 1",
    "Word": "sample string 2",
    "Excel": "sample string 3",
    "Pdf": "sample string 4",
    "Text": "sample string 5",
    "Archive": "sample string 6",
    "Custom": "sample string 7"
  },
  "ExternalSystemFormFieldDelimeter": "sample string 18",
  "ExternalSystemFormFieldTemplate": "sample string 19",
  "AuditFormFieldDelimeter": "sample string 20",
  "AuditFormFieldTemplate": "sample string 21",
  "MaxFileSizeKB": 22,
  "CalendarShowWeekends": true,
  "CalendarFirstDayOfTheWeekOffset": 24,
  "CalendarStartTimeOffset": 25,
  "CalendarEndTimeOffset": 26,
  "CalendarAgendaViewShowDuration": true,
  "CalendarDefaultViewType": "sample string 28",
  "CalendarSmallViewType": "sample string 29",
  "HelpPageUrl": "sample string 30",
  "ContactPageUrl": "sample string 31",
  "IconsTemplateUrl": "sample string 32",
  "EnableBobo": true,
  "EnableBase": true,
  "DisableRecurring": true,
  "DisableEditing": true,
  "AllowCancelPastBookings": true,
  "AllowCancelPastBookingsAdmin": true,
  "CustomFieldsLSE": true,
  "CustomFieldsCUHK": true,
  "BookingRequestAlternativeRedirect": true,
  "ShowAllCustomUserGroups": true,
  "CalendarNavigationLoadDelay": 43,
  "CalendarShowBookings": true,
  "FindTimetableShowBookings": true,
  "ActivityManagerHideBookings": true,
  "ActivityManagerActive": true,
  "ActivityManagerActiveToggleDate": "sample string 48",
  "ActivityManagerSelectableCategories": "sample string 49",
  "ActivityManagerStatusShowCount": true,
  "ActivityManagerStatusShowGraph": true,
  "FindTimetableResultsPerPage": 52,
  "FindTimetablePageDisable": true,
  "FindTimetableSelectableCategories": "sample string 54",
  "FindTimetableDefaultCategory": "sample string 55",
  "NotificationsPageDisable": true,
  "ActivityManagerMaxNoOfEvents": 57,
  "ActivityManagerMaxNoOfOccurrences": 58,
  "ActivityManagerMinObjectSelections": 59,
  "IcalExpandPopupByDefault": true,
  "IcalGoogle": "sample string 61",
  "IcalHideCalendarButtons": true,
  "IcalOutlookOnline": "sample string 63",
  "IcalOffice365": "sample string 64",
  "IcalYahoo": "sample string 65",
  "IcalUseDefaultUserGroup": true,
  "IcalShowBookings": true,
  "IcalShowBookingsToggleDateUtcManualEntry": "sample string 68",
  "MaxUpdate": 69,
  "ProcessPublishStatusDisabled": true
}

application/xml, text/xml

Sample:

<InstitutionSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <ActivityManagerActive>true</ActivityManagerActive>
  <ActivityManagerActiveToggleDate>sample string 48</ActivityManagerActiveToggleDate>
  <ActivityManagerHideBookings>true</ActivityManagerHideBookings>
  <ActivityManagerMaxNoOfEvents>57</ActivityManagerMaxNoOfEvents>
  <ActivityManagerMaxNoOfOccurrences>58</ActivityManagerMaxNoOfOccurrences>
  <ActivityManagerMinObjectSelections>59</ActivityManagerMinObjectSelections>
  <ActivityManagerSelectableCategories>sample string 49</ActivityManagerSelectableCategories>
  <ActivityManagerStatusShowCount>true</ActivityManagerStatusShowCount>
  <ActivityManagerStatusShowGraph>true</ActivityManagerStatusShowGraph>
  <AllowCancelPastBookings>true</AllowCancelPastBookings>
  <AllowCancelPastBookingsAdmin>true</AllowCancelPastBookingsAdmin>
  <AttachmentFileTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ConfigurableBookingForms">
    <d2p1:Archive>sample string 6</d2p1:Archive>
    <d2p1:Custom>sample string 7</d2p1:Custom>
    <d2p1:Excel>sample string 3</d2p1:Excel>
    <d2p1:Image>sample string 1</d2p1:Image>
    <d2p1:Pdf>sample string 4</d2p1:Pdf>
    <d2p1:Text>sample string 5</d2p1:Text>
    <d2p1:Word>sample string 2</d2p1:Word>
  </AttachmentFileTypes>
  <AuditFormFieldDelimeter>sample string 20</AuditFormFieldDelimeter>
  <AuditFormFieldTemplate>sample string 21</AuditFormFieldTemplate>
  <AutoApprove>true</AutoApprove>
  <BookingHistoryAdminOnly>true</BookingHistoryAdminOnly>
  <BookingRequestAlternativeRedirect>true</BookingRequestAlternativeRedirect>
  <CalendarAgendaViewShowDuration>true</CalendarAgendaViewShowDuration>
  <CalendarDefaultViewType>sample string 28</CalendarDefaultViewType>
  <CalendarEndTimeOffset>26</CalendarEndTimeOffset>
  <CalendarFirstDayOfTheWeekOffset>24</CalendarFirstDayOfTheWeekOffset>
  <CalendarNavigationLoadDelay>43</CalendarNavigationLoadDelay>
  <CalendarShowBookings>true</CalendarShowBookings>
  <CalendarShowWeekends>true</CalendarShowWeekends>
  <CalendarSmallViewType>sample string 29</CalendarSmallViewType>
  <CalendarStartTimeOffset>25</CalendarStartTimeOffset>
  <ClientId>sample string 8</ClientId>
  <ContactPageUrl>sample string 31</ContactPageUrl>
  <Culture>sample string 2</Culture>
  <CustomFieldsCUHK>true</CustomFieldsCUHK>
  <CustomFieldsLSE>true</CustomFieldsLSE>
  <DetailedUnavailabilityBookingDisplay>sample string 16</DetailedUnavailabilityBookingDisplay>
  <DisableEditing>true</DisableEditing>
  <DisableRecurring>true</DisableRecurring>
  <EnableBase>true</EnableBase>
  <EnableBobo>true</EnableBobo>
  <ExternalSystemFormFieldDelimeter>sample string 18</ExternalSystemFormFieldDelimeter>
  <ExternalSystemFormFieldTemplate>sample string 19</ExternalSystemFormFieldTemplate>
  <FindTimetableDefaultCategory>sample string 55</FindTimetableDefaultCategory>
  <FindTimetablePageDisable>true</FindTimetablePageDisable>
  <FindTimetableResultsPerPage>52</FindTimetableResultsPerPage>
  <FindTimetableSelectableCategories>sample string 54</FindTimetableSelectableCategories>
  <FindTimetableShowBookings>true</FindTimetableShowBookings>
  <HelpPageUrl>sample string 30</HelpPageUrl>
  <IcalExpandPopupByDefault>true</IcalExpandPopupByDefault>
  <IcalGoogle>sample string 61</IcalGoogle>
  <IcalHideCalendarButtons>true</IcalHideCalendarButtons>
  <IcalOffice365>sample string 64</IcalOffice365>
  <IcalOutlookOnline>sample string 63</IcalOutlookOnline>
  <IcalShowBookings>true</IcalShowBookings>
  <IcalShowBookingsToggleDateUtcManualEntry>sample string 68</IcalShowBookingsToggleDateUtcManualEntry>
  <IcalUseDefaultUserGroup>true</IcalUseDefaultUserGroup>
  <IcalYahoo>sample string 65</IcalYahoo>
  <IconsTemplateUrl>sample string 32</IconsTemplateUrl>
  <Identity>e787b85a-6b8e-45c5-94df-c44416ca11b5</Identity>
  <IsLite>true</IsLite>
  <MaxFileSizeKB>22</MaxFileSizeKB>
  <MaxOccurrences>11</MaxOccurrences>
  <MaxUpdate>69</MaxUpdate>
  <Name>sample string 1</Name>
  <NotificationWindow>7</NotificationWindow>
  <NotificationsPageDisable>true</NotificationsPageDisable>
  <ProcessPublishStatusDisabled>true</ProcessPublishStatusDisabled>
  <ReferenceFormat>sample string 14</ReferenceFormat>
  <ResourceCacheMinutes>10</ResourceCacheMinutes>
  <ResourcesListAdditionalLoadSize>13</ResourcesListAdditionalLoadSize>
  <ResourcesListInitialLoadSize>12</ResourcesListInitialLoadSize>
  <ShowAllCustomUserGroups>true</ShowAllCustomUserGroups>
  <SingleLogoutMode>6</SingleLogoutMode>
  <SystemMode>sample string 5</SystemMode>
  <TimeZone>sample string 3</TimeZone>
  <WebsiteConfig>
    <ApplicationName>sample string 11</ApplicationName>
    <BaseUrl>sample string 7</BaseUrl>
    <ClientId>sample string 1</ClientId>
    <EntityId>sample string 9</EntityId>
    <ExtraDatasets>sample string 2</ExtraDatasets>
    <Language>sample string 6</Language>
    <LogOnMessage>sample string 4</LogOnMessage>
    <LogOnMessageEnabled>true</LogOnMessageEnabled>
    <RedirectUrl>sample string 8</RedirectUrl>
    <Translations>sample string 12</Translations>
    <Version>sample string 5</Version>
    <WelcomeMessage>sample string 10</WelcomeMessage>
  </WebsiteConfig>
  <WeekendDays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </WeekendDays>
</InstitutionSettings>