POST api/DocumentService
Request Information
URI Parameters
None.
Body Parameters
ClsDocSvcInput| Name | Description | Type | Additional information |
|---|---|---|---|
| ActionType | EnumAction |
None. |
|
| FileURL | string |
None. |
|
| FileBase64 | string |
None. |
|
| FileName | string |
None. |
|
| DocType | EnumDocSvcFileType |
None. |
|
| Details | Collection of ClsMailMergeDetails |
None. |
|
| OutputType | EnumMailMergeOutput |
None. |
Request Formats
application/json, text/json
Sample:
{
"ActionType": 0,
"FileURL": "sample string 1",
"FileBase64": "sample string 2",
"FileName": "sample string 3",
"DocType": 0,
"Details": [
{
"Type": 0,
"Data": {},
"TagName": "sample string 2",
"DataName": "sample string 3",
"DocMerge": {
"MergeDocType": 0,
"MergeDocData": "sample string 1"
},
"DataStructure": {}
},
{
"Type": 0,
"Data": {},
"TagName": "sample string 2",
"DataName": "sample string 3",
"DocMerge": {
"MergeDocType": 0,
"MergeDocData": "sample string 1"
},
"DataStructure": {}
}
],
"OutputType": 0
}
application/xml, text/xml
Sample:
<DocumentService.ClsDocSvcInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TXTDocument_Service.DBO">
<ActionType>mailMerge</ActionType>
<Details>
<DocumentService.ClsMailMergeDetails>
<Data />
<DataName>sample string 3</DataName>
<DataStructure />
<DocMerge>
<MergeDocData>sample string 1</MergeDocData>
<MergeDocType>doc</MergeDocType>
</DocMerge>
<TagName>sample string 2</TagName>
<Type>Text</Type>
</DocumentService.ClsMailMergeDetails>
<DocumentService.ClsMailMergeDetails>
<Data />
<DataName>sample string 3</DataName>
<DataStructure />
<DocMerge>
<MergeDocData>sample string 1</MergeDocData>
<MergeDocType>doc</MergeDocType>
</DocMerge>
<TagName>sample string 2</TagName>
<Type>Text</Type>
</DocumentService.ClsMailMergeDetails>
</Details>
<DocType>doc</DocType>
<FileBase64>sample string 2</FileBase64>
<FileName>sample string 3</FileName>
<FileURL>sample string 1</FileURL>
<OutputType>doc</OutputType>
</DocumentService.ClsDocSvcInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ClsDocSvcResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | boolean |
None. |
|
| Base64File | string |
None. |
|
| DataObject | Object |
None. |
|
| Code | string |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": true,
"Base64File": "sample string 2",
"DataObject": {},
"Code": "sample string 4",
"Message": "sample string 5"
}
application/xml, text/xml
Sample:
<DocumentService.ClsDocSvcResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TXTDocument_Service.DBO"> <Base64File>sample string 2</Base64File> <Code>sample string 4</Code> <DataObject /> <Message>sample string 5</Message> <Status>true</Status> </DocumentService.ClsDocSvcResponse>