POST api/batch/{batchId}/case/{caseId}/documents/edit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| batchId | integer |
Required |
|
| caseId | string |
Required |
Body Parameters
EditDocumentRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| merge | EditDocumentModel |
None. |
|
| split | EditDocumentModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"merge": {
"nodeId": 1,
"nodeName": "sample string 2",
"documentName": "sample string 3",
"categoryId": 1,
"mergeDocuments": [
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
},
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
}
],
"splitDocuments": [
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
},
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
}
]
},
"split": {
"nodeId": 1,
"nodeName": "sample string 2",
"documentName": "sample string 3",
"categoryId": 1,
"mergeDocuments": [
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
},
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
}
],
"splitDocuments": [
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
},
{
"documentId": 1,
"page": 2,
"originalPageIndex": 3,
"order": 4
}
]
}
}
text/html
Sample:
{"merge":{"nodeId":1,"nodeName":"sample string 2","documentName":"sample string 3","categoryId":1,"mergeDocuments":[{"documentId":1,"page":2,"originalPageIndex":3,"order":4},{"documentId":1,"page":2,"originalPageIndex":3,"order":4}],"splitDocuments":[{"documentId":1,"page":2,"originalPageIndex":3,"order":4},{"documentId":1,"page":2,"originalPageIndex":3,"order":4}]},"split":{"nodeId":1,"nodeName":"sample string 2","documentName":"sample string 3","categoryId":1,"mergeDocuments":[{"documentId":1,"page":2,"originalPageIndex":3,"order":4},{"documentId":1,"page":2,"originalPageIndex":3,"order":4}],"splitDocuments":[{"documentId":1,"page":2,"originalPageIndex":3,"order":4},{"documentId":1,"page":2,"originalPageIndex":3,"order":4}]}}
application/xml, text/xml
Sample:
<EditDocumentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
<merge>
<categoryId>1</categoryId>
<documentName>sample string 3</documentName>
<mergeDocuments>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
</mergeDocuments>
<nodeId>1</nodeId>
<nodeName>sample string 2</nodeName>
<splitDocuments>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
</splitDocuments>
</merge>
<split>
<categoryId>1</categoryId>
<documentName>sample string 3</documentName>
<mergeDocuments>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
</mergeDocuments>
<nodeId>1</nodeId>
<nodeName>sample string 2</nodeName>
<splitDocuments>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
<EditDocumentPageItemModel>
<documentId>1</documentId>
<order>4</order>
<originalPageIndex>3</originalPageIndex>
<page>2</page>
</EditDocumentPageItemModel>
</splitDocuments>
</split>
</EditDocumentRequestModel>
multipart/form-data
Sample:
<EditDocumentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><merge><categoryId>1</categoryId><documentName>sample string 3</documentName><mergeDocuments><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel></mergeDocuments><nodeId>1</nodeId><nodeName>sample string 2</nodeName><splitDocuments><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel></splitDocuments></merge><split><categoryId>1</categoryId><documentName>sample string 3</documentName><mergeDocuments><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel></mergeDocuments><nodeId>1</nodeId><nodeName>sample string 2</nodeName><splitDocuments><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel><EditDocumentPageItemModel><documentId>1</documentId><order>4</order><originalPageIndex>3</originalPageIndex><page>2</page></EditDocumentPageItemModel></splitDocuments></split></EditDocumentRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |