POST api/JobArchive/InitializeSendToArchive

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

JobArchiveViewModel
NameDescriptionTypeAdditional 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": "56682090-9641-4093-ba6a-7ba3aff17cfc",
      "parentUid": "9ab76192-4d73-4bde-ad07-9897b29f676f",
      "clientDefaultContactUid": "a37bd4c4-06e4-460d-8996-dda1df7673c4"
    },
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "56682090-9641-4093-ba6a-7ba3aff17cfc",
      "parentUid": "9ab76192-4d73-4bde-ad07-9897b29f676f",
      "clientDefaultContactUid": "a37bd4c4-06e4-460d-8996-dda1df7673c4"
    }
  ],
  "selectedArchiveIndex": 1,
  "notification": {
    "title": "sample string 1",
    "description": "sample string 2",
    "type": 0,
    "identifier": "sample string 3"
  },
  "archiveName": "sample string 2",
  "jobs": [
    "e5c09505-9f00-4cff-b1e5-657b1ca84e0f",
    "d148faa6-c0b0-48cf-b0a0-e069bfcb3335"
  ]
}

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>a37bd4c4-06e4-460d-8996-dda1df7673c4</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>9ab76192-4d73-4bde-ad07-9897b29f676f</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>56682090-9641-4093-ba6a-7ba3aff17cfc</d2p1:_x003C_UniqueId_x003E_k__BackingField>
    </d2p1:LookupDto>
    <d2p1:LookupDto>
      <d2p1:_x003C_ClientDefaultContactUid_x003E_k__BackingField>a37bd4c4-06e4-460d-8996-dda1df7673c4</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>9ab76192-4d73-4bde-ad07-9897b29f676f</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>56682090-9641-4093-ba6a-7ba3aff17cfc</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>e5c09505-9f00-4cff-b1e5-657b1ca84e0f</d2p1:guid>
    <d2p1:guid>d148faa6-c0b0-48cf-b0a0-e069bfcb3335</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>