PUT api/MergeUpdateRTFDocument

Update current RTF, return selected RTF document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyKey	integer	None.
FileLinkArea	integer	None.
TemplateFileName	string	None.
MergeFile	Collection of MergeLetterProcessingFile	None.
NotSaved	boolean	None.
eDistribute	boolean	None.
SeparateLetters	boolean	None.
EmailPrintOptions	eDistributionEmailPrintOptions	None.
SequenceOptions	eDistributionSequenceOptions	None.
xmlDocumentLinkDSCompanyNoteKey	integer	None.
dsLetterDataCompanyNoteKey	integer	None.
EmailStatus	integer	None.
DocumentURL	string	None.
CurrentDocumentFileName	string	None.
SelectedDocumentFileName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyKey": 1,
  "FileLinkArea": 2,
  "TemplateFileName": "sample string 3",
  "MergeFile": [
    {
      "ParentRecordKey": 1,
      "RecordLinkKey": 2,
      "ForeignKey": 3,
      "BinaryFileName": "sample string 4",
      "BinaryFile": "sample string 5"
    },
    {
      "ParentRecordKey": 1,
      "RecordLinkKey": 2,
      "ForeignKey": 3,
      "BinaryFileName": "sample string 4",
      "BinaryFile": "sample string 5"
    }
  ],
  "NotSaved": true,
  "eDistribute": true,
  "SeparateLetters": true,
  "EmailPrintOptions": 0,
  "SequenceOptions": 0,
  "xmlDocumentLinkDSCompanyNoteKey": 7,
  "dsLetterDataCompanyNoteKey": 8,
  "EmailStatus": 9,
  "DocumentURL": "sample string 10",
  "CurrentDocumentFileName": "sample string 11",
  "SelectedDocumentFileName": "sample string 12"
}

application/xml, text/xml

Sample:

<MergeLetterProcessing xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.MergeLetter">
  <CompanyKey>1</CompanyKey>
  <CurrentDocumentFileName>sample string 11</CurrentDocumentFileName>
  <DocumentURL>sample string 10</DocumentURL>
  <EmailPrintOptions>AlwaysPrint</EmailPrintOptions>
  <EmailStatus>9</EmailStatus>
  <FileLinkArea>2</FileLinkArea>
  <MergeFile>
    <MergeLetterProcessingFile>
      <BinaryFile>sample string 5</BinaryFile>
      <BinaryFileName>sample string 4</BinaryFileName>
      <ForeignKey>3</ForeignKey>
      <ParentRecordKey>1</ParentRecordKey>
      <RecordLinkKey>2</RecordLinkKey>
    </MergeLetterProcessingFile>
    <MergeLetterProcessingFile>
      <BinaryFile>sample string 5</BinaryFile>
      <BinaryFileName>sample string 4</BinaryFileName>
      <ForeignKey>3</ForeignKey>
      <ParentRecordKey>1</ParentRecordKey>
      <RecordLinkKey>2</RecordLinkKey>
    </MergeLetterProcessingFile>
  </MergeFile>
  <NotSaved>true</NotSaved>
  <SelectedDocumentFileName>sample string 12</SelectedDocumentFileName>
  <SeparateLetters>true</SeparateLetters>
  <SequenceOptions>NotUsed</SequenceOptions>
  <TemplateFileName>sample string 3</TemplateFileName>
  <dsLetterDataCompanyNoteKey>8</dsLetterDataCompanyNoteKey>
  <eDistribute>true</eDistribute>
  <xmlDocumentLinkDSCompanyNoteKey>7</xmlDocumentLinkDSCompanyNoteKey>
</MergeLetterProcessing>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.