GET api/Public/UserCategoryTypeOptions/{institutionIdentity}?includeAdditional={includeAdditional}

Request Information

URI Parameters

Name	Description	Type	Additional information
institutionIdentity		string	Required
includeAdditional		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of CategoryTypeOptions

Name	Type	Additional information
IsAdditionalFilter	boolean	None.
DefaultFilter	Collection of CategoryValue	None.
CategorySelectionLimit	integer	None.
PageSize	integer	None.
CacheDurationMins	integer	None.
SearchFieldRestriction	Collection of string	None.
CategoryTypeId	globally unique identifier	None.
Name	string	None.
ViewDay	Collection of EventField	None.
ViewWeek	Collection of EventField	None.
ViewMonth	Collection of EventField	None.
ViewAgenda	Collection of EventField	None.
ViewLanes	Collection of EventField	None.
ViewDetails	Collection of EventField	None.
ViewExcel	Collection of EventField	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "IsAdditionalFilter": true,
    "DefaultFilter": [
      {
        "Identity": "cb60c545-fc6e-4915-a487-282cb7f2749b",
        "Values": [
          "24053462-7525-4116-9a39-267dd675c404",
          "f9929b64-a975-4a28-a481-6e0bb552b36f"
        ]
      },
      {
        "Identity": "cb60c545-fc6e-4915-a487-282cb7f2749b",
        "Values": [
          "24053462-7525-4116-9a39-267dd675c404",
          "f9929b64-a975-4a28-a481-6e0bb552b36f"
        ]
      }
    ],
    "CategorySelectionLimit": 2,
    "PageSize": 3,
    "CacheDurationMins": 4,
    "SearchFieldRestriction": [
      "sample string 1",
      "sample string 2"
    ],
    "CategoryTypeId": "f4802bc7-a083-44fa-85fb-c7b196bdd4c2",
    "Name": "sample string 6",
    "ViewDay": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewWeek": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewMonth": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewAgenda": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewLanes": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewDetails": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewExcel": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ]
  },
  {
    "IsAdditionalFilter": true,
    "DefaultFilter": [
      {
        "Identity": "cb60c545-fc6e-4915-a487-282cb7f2749b",
        "Values": [
          "24053462-7525-4116-9a39-267dd675c404",
          "f9929b64-a975-4a28-a481-6e0bb552b36f"
        ]
      },
      {
        "Identity": "cb60c545-fc6e-4915-a487-282cb7f2749b",
        "Values": [
          "24053462-7525-4116-9a39-267dd675c404",
          "f9929b64-a975-4a28-a481-6e0bb552b36f"
        ]
      }
    ],
    "CategorySelectionLimit": 2,
    "PageSize": 3,
    "CacheDurationMins": 4,
    "SearchFieldRestriction": [
      "sample string 1",
      "sample string 2"
    ],
    "CategoryTypeId": "f4802bc7-a083-44fa-85fb-c7b196bdd4c2",
    "Name": "sample string 6",
    "ViewDay": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewWeek": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewMonth": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewAgenda": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewLanes": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewDetails": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ],
    "ViewExcel": [
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "DisplayText": "sample string 2",
        "HideDisplayText": true,
        "Icon": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCategoryTypeOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <CategoryTypeOptions>
    <CategoryTypeId>f4802bc7-a083-44fa-85fb-c7b196bdd4c2</CategoryTypeId>
    <Name>sample string 6</Name>
    <ViewAgenda>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewAgenda>
    <ViewDay>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewDay>
    <ViewDetails>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewDetails>
    <ViewExcel>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewExcel>
    <ViewLanes>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewLanes>
    <ViewMonth>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewMonth>
    <ViewWeek>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewWeek>
    <CacheDurationMins>4</CacheDurationMins>
    <CategorySelectionLimit>2</CategorySelectionLimit>
    <DefaultFilter>
      <CategoryValue>
        <Identity>cb60c545-fc6e-4915-a487-282cb7f2749b</Identity>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>24053462-7525-4116-9a39-267dd675c404</d5p1:guid>
          <d5p1:guid>f9929b64-a975-4a28-a481-6e0bb552b36f</d5p1:guid>
        </Values>
      </CategoryValue>
      <CategoryValue>
        <Identity>cb60c545-fc6e-4915-a487-282cb7f2749b</Identity>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>24053462-7525-4116-9a39-267dd675c404</d5p1:guid>
          <d5p1:guid>f9929b64-a975-4a28-a481-6e0bb552b36f</d5p1:guid>
        </Values>
      </CategoryValue>
    </DefaultFilter>
    <IsAdditionalFilter>true</IsAdditionalFilter>
    <PageSize>3</PageSize>
    <SearchFieldRestriction xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SearchFieldRestriction>
  </CategoryTypeOptions>
  <CategoryTypeOptions>
    <CategoryTypeId>f4802bc7-a083-44fa-85fb-c7b196bdd4c2</CategoryTypeId>
    <Name>sample string 6</Name>
    <ViewAgenda>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewAgenda>
    <ViewDay>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewDay>
    <ViewDetails>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewDetails>
    <ViewExcel>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewExcel>
    <ViewLanes>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewLanes>
    <ViewMonth>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewMonth>
    <ViewWeek>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
      <EventField>
        <DisplayText>sample string 2</DisplayText>
        <HideDisplayText>true</HideDisplayText>
        <Icon>sample string 4</Icon>
        <Name>sample string 1</Name>
      </EventField>
    </ViewWeek>
    <CacheDurationMins>4</CacheDurationMins>
    <CategorySelectionLimit>2</CategorySelectionLimit>
    <DefaultFilter>
      <CategoryValue>
        <Identity>cb60c545-fc6e-4915-a487-282cb7f2749b</Identity>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>24053462-7525-4116-9a39-267dd675c404</d5p1:guid>
          <d5p1:guid>f9929b64-a975-4a28-a481-6e0bb552b36f</d5p1:guid>
        </Values>
      </CategoryValue>
      <CategoryValue>
        <Identity>cb60c545-fc6e-4915-a487-282cb7f2749b</Identity>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>24053462-7525-4116-9a39-267dd675c404</d5p1:guid>
          <d5p1:guid>f9929b64-a975-4a28-a481-6e0bb552b36f</d5p1:guid>
        </Values>
      </CategoryValue>
    </DefaultFilter>
    <IsAdditionalFilter>true</IsAdditionalFilter>
    <PageSize>3</PageSize>
    <SearchFieldRestriction xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SearchFieldRestriction>
  </CategoryTypeOptions>
</ArrayOfCategoryTypeOptions>