POST api/JobArchive/InitializeSendToArchive

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	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": "2f99bb33-244f-4bcd-bc84-88de380504b2",
      "parentUid": "3a5cfdf3-167d-4e3d-9bac-0c322bcd5037"
    },
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "2f99bb33-244f-4bcd-bc84-88de380504b2",
      "parentUid": "3a5cfdf3-167d-4e3d-9bac-0c322bcd5037"
    }
  ],
  "selectedArchiveIndex": 1,
  "notification": {
    "title": "sample string 1",
    "description": "sample string 2",
    "type": 0,
    "identifier": "sample string 3"
  },
  "archiveName": "sample string 2",
  "jobs": [
    "fe96be60-0709-461b-94e2-bbbb1c66ff4b",
    "a778de44-3117-48ee-8af4-99aad1dd9469"
  ]
}

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_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>3a5cfdf3-167d-4e3d-9bac-0c322bcd5037</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>2f99bb33-244f-4bcd-bc84-88de380504b2</d2p1:_x003C_UniqueId_x003E_k__BackingField>
    </d2p1:LookupDto>
    <d2p1:LookupDto>
      <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>3a5cfdf3-167d-4e3d-9bac-0c322bcd5037</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>2f99bb33-244f-4bcd-bc84-88de380504b2</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>fe96be60-0709-461b-94e2-bbbb1c66ff4b</d2p1:guid>
    <d2p1:guid>a778de44-3117-48ee-8af4-99aad1dd9469</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>