POST api/Letter/SaveAsJobLetter

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProcessStageId	integer	None.
WindowId	integer	None.
WindowName	string	None.
LetterName	string	None.
LetterContent	string	None.
ToAddress	string	None.
CcAddress	string	None.
Subject	string	None.
EnableDelete	boolean	None.
IsDefaultLetter	boolean	None.
LettersList	Collection of LetterPropertiesDto	None.
SharedCheckBox	CheckBoxDto	None.

Request Formats

application/json, text/json

Sample:

{
  "sharedCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "processStageId": 1,
  "windowId": 2,
  "windowName": "sample string 3",
  "letterName": "sample string 4",
  "letterContent": "sample string 5",
  "toAddress": "sample string 6",
  "ccAddress": "sample string 7",
  "subject": "sample string 8",
  "enableDelete": true,
  "isDefaultLetter": true,
  "lettersList": [
    {
      "letterTitle": "sample string 1",
      "letterContent": "sample string 2",
      "toAddress": "sample string 3",
      "ccAddress": "sample string 4",
      "subject": "sample string 5",
      "dateCreated": "sample string 6"
    },
    {
      "letterTitle": "sample string 1",
      "letterContent": "sample string 2",
      "toAddress": "sample string 3",
      "ccAddress": "sample string 4",
      "subject": "sample string 5",
      "dateCreated": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<LetterParameterDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
  <CcAddress>sample string 7</CcAddress>
  <EnableDelete>true</EnableDelete>
  <IsDefaultLetter>true</IsDefaultLetter>
  <LetterContent>sample string 5</LetterContent>
  <LetterName>sample string 4</LetterName>
  <LettersList>
    <LetterPropertiesDto>
      <CcAddress>sample string 4</CcAddress>
      <DateCreated>sample string 6</DateCreated>
      <LetterContent>sample string 2</LetterContent>
      <LetterTitle>sample string 1</LetterTitle>
      <Subject>sample string 5</Subject>
      <ToAddress>sample string 3</ToAddress>
    </LetterPropertiesDto>
    <LetterPropertiesDto>
      <CcAddress>sample string 4</CcAddress>
      <DateCreated>sample string 6</DateCreated>
      <LetterContent>sample string 2</LetterContent>
      <LetterTitle>sample string 1</LetterTitle>
      <Subject>sample string 5</Subject>
      <ToAddress>sample string 3</ToAddress>
    </LetterPropertiesDto>
  </LettersList>
  <ProcessStageId>1</ProcessStageId>
  <SharedCheckBox 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>
  </SharedCheckBox>
  <Subject>sample string 8</Subject>
  <ToAddress>sample string 6</ToAddress>
  <WindowId>2</WindowId>
  <WindowName>sample string 3</WindowName>
</LetterParameterDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LetterParameterDto

Name	Type	Additional information
ProcessStageId	integer	None.
WindowId	integer	None.
WindowName	string	None.
LetterName	string	None.
LetterContent	string	None.
ToAddress	string	None.
CcAddress	string	None.
Subject	string	None.
EnableDelete	boolean	None.
IsDefaultLetter	boolean	None.
LettersList	Collection of LetterPropertiesDto	None.
SharedCheckBox	CheckBoxDto	None.

Response Formats

application/json, text/json

Sample:

{
  "sharedCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "processStageId": 1,
  "windowId": 2,
  "windowName": "sample string 3",
  "letterName": "sample string 4",
  "letterContent": "sample string 5",
  "toAddress": "sample string 6",
  "ccAddress": "sample string 7",
  "subject": "sample string 8",
  "enableDelete": true,
  "isDefaultLetter": true,
  "lettersList": [
    {
      "letterTitle": "sample string 1",
      "letterContent": "sample string 2",
      "toAddress": "sample string 3",
      "ccAddress": "sample string 4",
      "subject": "sample string 5",
      "dateCreated": "sample string 6"
    },
    {
      "letterTitle": "sample string 1",
      "letterContent": "sample string 2",
      "toAddress": "sample string 3",
      "ccAddress": "sample string 4",
      "subject": "sample string 5",
      "dateCreated": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<LetterParameterDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
  <CcAddress>sample string 7</CcAddress>
  <EnableDelete>true</EnableDelete>
  <IsDefaultLetter>true</IsDefaultLetter>
  <LetterContent>sample string 5</LetterContent>
  <LetterName>sample string 4</LetterName>
  <LettersList>
    <LetterPropertiesDto>
      <CcAddress>sample string 4</CcAddress>
      <DateCreated>sample string 6</DateCreated>
      <LetterContent>sample string 2</LetterContent>
      <LetterTitle>sample string 1</LetterTitle>
      <Subject>sample string 5</Subject>
      <ToAddress>sample string 3</ToAddress>
    </LetterPropertiesDto>
    <LetterPropertiesDto>
      <CcAddress>sample string 4</CcAddress>
      <DateCreated>sample string 6</DateCreated>
      <LetterContent>sample string 2</LetterContent>
      <LetterTitle>sample string 1</LetterTitle>
      <Subject>sample string 5</Subject>
      <ToAddress>sample string 3</ToAddress>
    </LetterPropertiesDto>
  </LettersList>
  <ProcessStageId>1</ProcessStageId>
  <SharedCheckBox 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>
  </SharedCheckBox>
  <Subject>sample string 8</Subject>
  <ToAddress>sample string 6</ToAddress>
  <WindowId>2</WindowId>
  <WindowName>sample string 3</WindowName>
</LetterParameterDto>