GET api/Public/ViewOptions/{institutionIdentity}

Request Information

URI Parameters

Name	Description	Type	Additional information
institutionIdentity		string	Required

Body Parameters

None.

Response Information

Resource Description

ViewOptions

Name	Type	Additional information
TimePeriods	Collection of TimePeriod	None.
DatePeriods	Collection of DatePeriod	None.
Weeks	Collection of Week	None.
LegendItems	Collection of LegendItem	None.
Days	Collection of Day	None.

Response Formats

application/json, text/json

Sample:

{
  "TimePeriods": [
    {
      "Description": "sample string 1",
      "StartTime": "sample string 2",
      "EndTime": "sample string 3",
      "IsDefault": true
    },
    {
      "Description": "sample string 1",
      "StartTime": "sample string 2",
      "EndTime": "sample string 3",
      "IsDefault": true
    }
  ],
  "DatePeriods": [
    {
      "Description": "sample string 1",
      "StartDateTime": "2025-01-28T22:19:08.4324885+00:00",
      "EndDateTime": "2025-01-28T22:19:08.4324885+00:00",
      "IsDefault": true,
      "Type": "sample string 5"
    },
    {
      "Description": "sample string 1",
      "StartDateTime": "2025-01-28T22:19:08.4324885+00:00",
      "EndDateTime": "2025-01-28T22:19:08.4324885+00:00",
      "IsDefault": true,
      "Type": "sample string 5"
    }
  ],
  "Weeks": [
    {
      "WeekNumber": 1,
      "WeekLabel": "sample string 2",
      "FirstDayInWeek": "2025-01-28T22:19:08.4324885+00:00"
    },
    {
      "WeekNumber": 1,
      "WeekLabel": "sample string 2",
      "FirstDayInWeek": "2025-01-28T22:19:08.4324885+00:00"
    }
  ],
  "LegendItems": [
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "Icon": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "Icon": "sample string 3"
    }
  ],
  "Days": [
    {
      "Name": "sample string 1",
      "DayOfWeek": 0,
      "IsDefault": true
    },
    {
      "Name": "sample string 1",
      "DayOfWeek": 0,
      "IsDefault": true
    }
  ]
}

application/xml, text/xml

Sample:

<ViewOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <DatePeriods>
    <DatePeriod>
      <Description>sample string 1</Description>
      <EndDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-01-28T22:19:08.4324885Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </EndDateTime>
      <IsDefault>true</IsDefault>
      <StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-01-28T22:19:08.4324885Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </StartDateTime>
      <Type>sample string 5</Type>
    </DatePeriod>
    <DatePeriod>
      <Description>sample string 1</Description>
      <EndDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-01-28T22:19:08.4324885Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </EndDateTime>
      <IsDefault>true</IsDefault>
      <StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-01-28T22:19:08.4324885Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </StartDateTime>
      <Type>sample string 5</Type>
    </DatePeriod>
  </DatePeriods>
  <Days>
    <Day>
      <DayOfWeek>Sunday</DayOfWeek>
      <IsDefault>true</IsDefault>
      <Name>sample string 1</Name>
    </Day>
    <Day>
      <DayOfWeek>Sunday</DayOfWeek>
      <IsDefault>true</IsDefault>
      <Name>sample string 1</Name>
    </Day>
  </Days>
  <LegendItems>
    <LegendItem>
      <DisplayName>sample string 2</DisplayName>
      <Icon>sample string 3</Icon>
      <Name>sample string 1</Name>
    </LegendItem>
    <LegendItem>
      <DisplayName>sample string 2</DisplayName>
      <Icon>sample string 3</Icon>
      <Name>sample string 1</Name>
    </LegendItem>
  </LegendItems>
  <TimePeriods>
    <TimePeriod>
      <Description>sample string 1</Description>
      <EndTime>sample string 3</EndTime>
      <IsDefault>true</IsDefault>
      <StartTime>sample string 2</StartTime>
    </TimePeriod>
    <TimePeriod>
      <Description>sample string 1</Description>
      <EndTime>sample string 3</EndTime>
      <IsDefault>true</IsDefault>
      <StartTime>sample string 2</StartTime>
    </TimePeriod>
  </TimePeriods>
  <Weeks>
    <Week>
      <FirstDayInWeek xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-01-28T22:19:08.4324885Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </FirstDayInWeek>
      <WeekLabel>sample string 2</WeekLabel>
      <WeekNumber>1</WeekNumber>
    </Week>
    <Week>
      <FirstDayInWeek xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-01-28T22:19:08.4324885Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </FirstDayInWeek>
      <WeekLabel>sample string 2</WeekLabel>
      <WeekNumber>1</WeekNumber>
    </Week>
  </Weeks>
</ViewOptions>