POST api/JobArchive/OpenJobArchive
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
JobArchiveViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Archives | Collection of LookupDto |
None. |
|
| SelectedArchiveIndex | integer |
None. |
|
| Notification | NotificationDto |
None. |
|
| ArchiveName | string |
None. |
|
| Jobs | Collection of globally unique identifier |
None. |
|
| ArchiveCaption | LabelDto |
None. |
|
| OkButton | CommandButtonDto |
None. |
|
| DeleteImagesCheckBox | CheckBoxDto |
None. |
|
| NewArchiveButton | CommandButtonDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"archiveCaption": {
"caption": "sample string 1",
"visible": true,
"enabled": true
},
"okButton": {
"visible": true,
"enabled": true,
"caption": "sample string 3"
},
"deleteImagesCheckBox": {
"checked": true,
"visible": true,
"enabled": true,
"caption": "sample string 4"
},
"newArchiveButton": {
"visible": true,
"enabled": true,
"caption": "sample string 3"
},
"archives": [
{
"id": 1,
"idString": "sample string 2",
"name": "sample string 3",
"parentId": "sample string 4",
"description": "sample string 5",
"selected": true,
"sortIndex": 7,
"uniqueId": "2c9d39e2-5082-4fba-ae97-0a231edd99a8",
"parentUid": "fc28307a-7d6c-474a-81e5-09291c68052a",
"clientDefaultContactUid": "d8277f01-3647-4fda-b11b-21ae9f4f8738"
},
{
"id": 1,
"idString": "sample string 2",
"name": "sample string 3",
"parentId": "sample string 4",
"description": "sample string 5",
"selected": true,
"sortIndex": 7,
"uniqueId": "2c9d39e2-5082-4fba-ae97-0a231edd99a8",
"parentUid": "fc28307a-7d6c-474a-81e5-09291c68052a",
"clientDefaultContactUid": "d8277f01-3647-4fda-b11b-21ae9f4f8738"
}
],
"selectedArchiveIndex": 1,
"notification": {
"title": "sample string 1",
"description": "sample string 2",
"type": 0,
"identifier": "sample string 3"
},
"archiveName": "sample string 2",
"jobs": [
"f97d410d-8bd9-493f-95e8-d75327eabb24",
"a6db4a75-9a8d-4db7-b2b7-ad9f197640bd"
]
}
application/xml, text/xml
Sample:
<JobArchiveViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<ArchiveCaption xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 1</d2p1:Caption>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</ArchiveCaption>
<ArchiveName>sample string 2</ArchiveName>
<Archives xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
<d2p1:LookupDto>
<d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>d8277f01-3647-4fda-b11b-21ae9f4f8738</d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
<d2p1:_x003C_ParentUid_x003E_k__BackingField>fc28307a-7d6c-474a-81e5-09291c68052a</d2p1:_x003C_ParentUid_x003E_k__BackingField>
<d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
<d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
<d2p1:_x003C_UniqueId_x003E_k__BackingField>2c9d39e2-5082-4fba-ae97-0a231edd99a8</d2p1:_x003C_UniqueId_x003E_k__BackingField>
</d2p1:LookupDto>
<d2p1:LookupDto>
<d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>d8277f01-3647-4fda-b11b-21ae9f4f8738</d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
<d2p1:_x003C_ParentUid_x003E_k__BackingField>fc28307a-7d6c-474a-81e5-09291c68052a</d2p1:_x003C_ParentUid_x003E_k__BackingField>
<d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
<d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
<d2p1:_x003C_UniqueId_x003E_k__BackingField>2c9d39e2-5082-4fba-ae97-0a231edd99a8</d2p1:_x003C_UniqueId_x003E_k__BackingField>
</d2p1:LookupDto>
</Archives>
<DeleteImagesCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 4</d2p1:Caption>
<d2p1:Checked>true</d2p1:Checked>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</DeleteImagesCheckBox>
<Jobs xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:guid>f97d410d-8bd9-493f-95e8-d75327eabb24</d2p1:guid>
<d2p1:guid>a6db4a75-9a8d-4db7-b2b7-ad9f197640bd</d2p1:guid>
</Jobs>
<NewArchiveButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 3</d2p1:Caption>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</NewArchiveButton>
<Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Common">
<d2p1:_x003C_Description_x003E_k__BackingField>sample string 2</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_Identifier_x003E_k__BackingField>sample string 3</d2p1:_x003C_Identifier_x003E_k__BackingField>
<d2p1:_x003C_Title_x003E_k__BackingField>sample string 1</d2p1:_x003C_Title_x003E_k__BackingField>
<d2p1:_x003C_Type_x003E_k__BackingField>Default</d2p1:_x003C_Type_x003E_k__BackingField>
</Notification>
<OkButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
<d2p1:Caption>sample string 3</d2p1:Caption>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:Visible>true</d2p1:Visible>
</OkButton>
<SelectedArchiveIndex>1</SelectedArchiveIndex>
</JobArchiveViewModel>