GET api/ScheduleSettings/InitializeScheduleSettings
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ScheduleSettingsViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | integer |
None. |
|
| UserRowCount | integer |
None. |
|
| LoopCaptions | Collection of LoopCaptionsViewModel |
None. |
|
| FontName | string |
None. |
|
| FontSize | integer |
None. |
|
| RowPadding | integer |
None. |
|
| BorderThick | integer |
None. |
|
| ShowAgreedOffset | boolean |
None. |
|
| CellLines | integer |
None. |
|
| JobLabelCount | integer |
None. |
|
| LoopLabels | Collection of LoopLabelsViewModel |
None. |
|
| BorderAttributeName | string |
None. |
|
| FillAttributeName | string |
None. |
|
| TextAttributeName | string |
None. |
|
| ColorCount | integer |
None. |
|
| LoopNames | Collection of LoopNamesViewModel |
None. |
|
| ActionCount | integer |
None. |
|
| LoopActions | Collection of LoopActionsViewModel |
None. |
|
| SaveLocal | boolean |
None. |
|
| ShowIcons | boolean |
None. |
|
| IconMargin | integer |
None. |
|
| SecondColumnWidth | integer |
None. |
|
| IconList | string |
None. |
|
| WeekViewDays | integer |
None. |
|
| HideFixedColumn | boolean |
None. |
|
| IconsOnBottom | boolean |
None. |
|
| SplitHours | boolean |
None. |
|
| ShowValuesProduction | integer |
None. |
|
| ShowValuesInstall | integer |
None. |
|
| AvailableColumns | Collection of DirectoryColumnViewModel |
None. |
|
| IsRestrictDateRange | boolean |
None. |
|
| DateFrom | date |
None. |
|
| DateTo | date |
None. |
|
| ProductionStartDate | date |
None. |
|
| ProductionEndDate | date |
None. |
|
| InstallationStartDate | date |
None. |
|
| InstallationEndDate | date |
None. |
|
| ShortDateFormat | string |
None. |
|
| IconSettings | Collection of SchedSettingsIconList |
None. |
|
| IconListSource | Collection of IconList |
None. |
|
| ShowAllJobsStartDate | date |
None. |
|
| ShowAllJobsEndDate | date |
None. |
|
| ShowAllJobs | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"version": 1,
"userRowCount": 2,
"loopCaptions": [
{
"userRowCaptions": "sample string 1"
},
{
"userRowCaptions": "sample string 1"
}
],
"fontName": "sample string 3",
"fontSize": 4,
"rowPadding": 5,
"borderThick": 6,
"showAgreedOffset": true,
"cellLines": 8,
"jobLabelCount": 9,
"loopLabels": [
{
"jobLabels": "sample string 1",
"columnName": "sample string 2",
"value": "sample string 3"
},
{
"jobLabels": "sample string 1",
"columnName": "sample string 2",
"value": "sample string 3"
}
],
"borderAttributeName": "sample string 10",
"fillAttributeName": "sample string 11",
"textAttributeName": "sample string 12",
"colorCount": 13,
"loopNames": [
{
"borderNames": "sample string 1",
"fillNames": "sample string 2",
"textNames": "sample string 3"
},
{
"borderNames": "sample string 1",
"fillNames": "sample string 2",
"textNames": "sample string 3"
}
],
"actionCount": 14,
"loopActions": [
{
"actionLabel": "sample string 1",
"actions": "sample string 2"
},
{
"actionLabel": "sample string 1",
"actions": "sample string 2"
}
],
"saveLocal": true,
"showIcons": true,
"iconMargin": 17,
"secondColumnWidth": 18,
"iconList": "sample string 19",
"weekViewDays": 20,
"hideFixedColumn": true,
"iconsOnBottom": true,
"splitHours": true,
"showValuesProduction": 24,
"showValuesInstall": 25,
"availableColumns": [
{
"tableName": "sample string 1",
"fieldName": "sample string 2",
"columnName": "sample string 3",
"dataType": 0,
"sorted": 4,
"width": "sample string 5"
},
{
"tableName": "sample string 1",
"fieldName": "sample string 2",
"columnName": "sample string 3",
"dataType": 0,
"sorted": 4,
"width": "sample string 5"
}
],
"isRestrictDateRange": true,
"dateFrom": "2025-11-02T15:09:20.0960561+00:00",
"dateTo": "2025-11-02T15:09:20.0960561+00:00",
"productionStartDate": "2025-11-02T15:09:20.0960561+00:00",
"productionEndDate": "2025-11-02T15:09:20.0960561+00:00",
"installationStartDate": "2025-11-02T15:09:20.0960561+00:00",
"installationEndDate": "2025-11-02T15:09:20.0960561+00:00",
"shortDateFormat": "sample string 33",
"iconSettings": [
{
"uid": "40af6e41-1e51-4b20-b489-4d56305569f4",
"fileName": "sample string 2",
"extension": "sample string 3",
"label": "sample string 4"
},
{
"uid": "40af6e41-1e51-4b20-b489-4d56305569f4",
"fileName": "sample string 2",
"extension": "sample string 3",
"label": "sample string 4"
}
],
"iconListSource": [
{
"uid": "f291a252-b3ee-4b18-8c43-2a6b149c36f9",
"fileName": "sample string 2",
"extension": "sample string 3",
"name": "sample string 4"
},
{
"uid": "f291a252-b3ee-4b18-8c43-2a6b149c36f9",
"fileName": "sample string 2",
"extension": "sample string 3",
"name": "sample string 4"
}
],
"showAllJobsStartDate": "2025-11-02T15:09:20.0960561+00:00",
"showAllJobsEndDate": "2025-11-02T15:09:20.0960561+00:00",
"showAllJobs": true
}
application/xml, text/xml
Sample:
<ScheduleSettingsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<ActionCount>14</ActionCount>
<AvailableColumns>
<DirectoryColumnViewModel>
<ColumnName>sample string 3</ColumnName>
<DataType>TextEdit</DataType>
<FieldName>sample string 2</FieldName>
<Sorted>4</Sorted>
<TableName>sample string 1</TableName>
<Width>sample string 5</Width>
</DirectoryColumnViewModel>
<DirectoryColumnViewModel>
<ColumnName>sample string 3</ColumnName>
<DataType>TextEdit</DataType>
<FieldName>sample string 2</FieldName>
<Sorted>4</Sorted>
<TableName>sample string 1</TableName>
<Width>sample string 5</Width>
</DirectoryColumnViewModel>
</AvailableColumns>
<BorderAttributeName>sample string 10</BorderAttributeName>
<BorderThick>6</BorderThick>
<CellLines>8</CellLines>
<ColorCount>13</ColorCount>
<DateFrom>2025-11-02T15:09:20.0960561+00:00</DateFrom>
<DateTo>2025-11-02T15:09:20.0960561+00:00</DateTo>
<FillAttributeName>sample string 11</FillAttributeName>
<FontName>sample string 3</FontName>
<FontSize>4</FontSize>
<HideFixedColumn>true</HideFixedColumn>
<IconList>sample string 19</IconList>
<IconListSource>
<IconList>
<Extension>sample string 3</Extension>
<FileName>sample string 2</FileName>
<Name>sample string 4</Name>
<Uid>f291a252-b3ee-4b18-8c43-2a6b149c36f9</Uid>
</IconList>
<IconList>
<Extension>sample string 3</Extension>
<FileName>sample string 2</FileName>
<Name>sample string 4</Name>
<Uid>f291a252-b3ee-4b18-8c43-2a6b149c36f9</Uid>
</IconList>
</IconListSource>
<IconMargin>17</IconMargin>
<IconSettings>
<SchedSettingsIconList>
<Extension>sample string 3</Extension>
<FileName>sample string 2</FileName>
<Label>sample string 4</Label>
<Uid>40af6e41-1e51-4b20-b489-4d56305569f4</Uid>
</SchedSettingsIconList>
<SchedSettingsIconList>
<Extension>sample string 3</Extension>
<FileName>sample string 2</FileName>
<Label>sample string 4</Label>
<Uid>40af6e41-1e51-4b20-b489-4d56305569f4</Uid>
</SchedSettingsIconList>
</IconSettings>
<IconsOnBottom>true</IconsOnBottom>
<InstallationEndDate>2025-11-02T15:09:20.0960561+00:00</InstallationEndDate>
<InstallationStartDate>2025-11-02T15:09:20.0960561+00:00</InstallationStartDate>
<IsRestrictDateRange>true</IsRestrictDateRange>
<JobLabelCount>9</JobLabelCount>
<LoopActions>
<LoopActionsViewModel>
<ActionLabel>sample string 1</ActionLabel>
<Actions>sample string 2</Actions>
</LoopActionsViewModel>
<LoopActionsViewModel>
<ActionLabel>sample string 1</ActionLabel>
<Actions>sample string 2</Actions>
</LoopActionsViewModel>
</LoopActions>
<LoopCaptions>
<LoopCaptionsViewModel>
<UserRowCaptions>sample string 1</UserRowCaptions>
</LoopCaptionsViewModel>
<LoopCaptionsViewModel>
<UserRowCaptions>sample string 1</UserRowCaptions>
</LoopCaptionsViewModel>
</LoopCaptions>
<LoopLabels>
<LoopLabelsViewModel>
<ColumnName>sample string 2</ColumnName>
<JobLabels>sample string 1</JobLabels>
<Value>sample string 3</Value>
</LoopLabelsViewModel>
<LoopLabelsViewModel>
<ColumnName>sample string 2</ColumnName>
<JobLabels>sample string 1</JobLabels>
<Value>sample string 3</Value>
</LoopLabelsViewModel>
</LoopLabels>
<LoopNames>
<LoopNamesViewModel>
<BorderNames>sample string 1</BorderNames>
<FillNames>sample string 2</FillNames>
<TextNames>sample string 3</TextNames>
</LoopNamesViewModel>
<LoopNamesViewModel>
<BorderNames>sample string 1</BorderNames>
<FillNames>sample string 2</FillNames>
<TextNames>sample string 3</TextNames>
</LoopNamesViewModel>
</LoopNames>
<ProductionEndDate>2025-11-02T15:09:20.0960561+00:00</ProductionEndDate>
<ProductionStartDate>2025-11-02T15:09:20.0960561+00:00</ProductionStartDate>
<RowPadding>5</RowPadding>
<SaveLocal>true</SaveLocal>
<SecondColumnWidth>18</SecondColumnWidth>
<ShortDateFormat>sample string 33</ShortDateFormat>
<ShowAgreedOffset>true</ShowAgreedOffset>
<ShowAllJobs>true</ShowAllJobs>
<ShowAllJobsEndDate>2025-11-02T15:09:20.0960561+00:00</ShowAllJobsEndDate>
<ShowAllJobsStartDate>2025-11-02T15:09:20.0960561+00:00</ShowAllJobsStartDate>
<ShowIcons>true</ShowIcons>
<ShowValuesInstall>25</ShowValuesInstall>
<ShowValuesProduction>24</ShowValuesProduction>
<SplitHours>true</SplitHours>
<TextAttributeName>sample string 12</TextAttributeName>
<UserRowCount>2</UserRowCount>
<Version>1</Version>
<WeekViewDays>20</WeekViewDays>
</ScheduleSettingsViewModel>