POST api/MergeDocumentTemplate?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Return request RTF template file

Request Information

URI Parameters

NameDescriptionTypeAdditional information
VendorID

string

Required

VendorPassword

string

Required

APIGUID

string

Required

Body Parameters

MergeLetterTemplate
NameDescriptionTypeAdditional information
FileLinkArea

integer

None.

FileName

string

None.

NewFileName

string

None.

ImageBase64

string

None.

Status

string

None.

MergeFields

Collection of MergeField

None.

Request Formats

application/json, text/json

Sample:
{
  "FileLinkArea": 1,
  "FileName": "sample string 2",
  "NewFileName": "sample string 3",
  "ImageBase64": "sample string 4",
  "Status": "sample string 5",
  "MergeFields": [
    {
      "ColumnName": "sample string 1"
    },
    {
      "ColumnName": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<MergeLetterTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.MergeLetter">
  <FileLinkArea>1</FileLinkArea>
  <FileName>sample string 2</FileName>
  <ImageBase64>sample string 4</ImageBase64>
  <MergeFields>
    <MergeField>
      <ColumnName>sample string 1</ColumnName>
    </MergeField>
    <MergeField>
      <ColumnName>sample string 1</ColumnName>
    </MergeField>
  </MergeFields>
  <NewFileName>sample string 3</NewFileName>
  <Status>sample string 5</Status>
</MergeLetterTemplate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.