PUT api/TimetableOptions/ConfigurableCategoryTypeOptions
Request Information
URI Parameters
None.
Body Parameters
Collection of ConfigurableCategoryTypeOptions| Name | Description | Type | Additional information |
|---|---|---|---|
| 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. |
Request Formats
application/json, text/json
Sample:
[
{
"CategoryTypeId": "3dac515e-30c0-432c-bd0f-76dd2fe3c470",
"Name": "sample string 2",
"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"
}
]
},
{
"CategoryTypeId": "3dac515e-30c0-432c-bd0f-76dd2fe3c470",
"Name": "sample string 2",
"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:
<ArrayOfConfigurableCategoryTypeOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
<ConfigurableCategoryTypeOptions>
<CategoryTypeId>3dac515e-30c0-432c-bd0f-76dd2fe3c470</CategoryTypeId>
<Name>sample string 2</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>
</ConfigurableCategoryTypeOptions>
<ConfigurableCategoryTypeOptions>
<CategoryTypeId>3dac515e-30c0-432c-bd0f-76dd2fe3c470</CategoryTypeId>
<Name>sample string 2</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>
</ConfigurableCategoryTypeOptions>
</ArrayOfConfigurableCategoryTypeOptions>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ConfigurableCategoryTypeOptions| Name | Description | Type | Additional information |
|---|---|---|---|
| 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:
[
{
"CategoryTypeId": "c813bcab-027d-4cb1-9e4c-a68ea66733e0",
"Name": "sample string 2",
"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"
}
]
},
{
"CategoryTypeId": "c813bcab-027d-4cb1-9e4c-a68ea66733e0",
"Name": "sample string 2",
"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:
<ArrayOfConfigurableCategoryTypeOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
<ConfigurableCategoryTypeOptions>
<CategoryTypeId>c813bcab-027d-4cb1-9e4c-a68ea66733e0</CategoryTypeId>
<Name>sample string 2</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>
</ConfigurableCategoryTypeOptions>
<ConfigurableCategoryTypeOptions>
<CategoryTypeId>c813bcab-027d-4cb1-9e4c-a68ea66733e0</CategoryTypeId>
<Name>sample string 2</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>
</ConfigurableCategoryTypeOptions>
</ArrayOfConfigurableCategoryTypeOptions>