POST api/batch/{batchId}/document/payment/{paymentId}/document/node/{nodeId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
batchId

integer

Required

paymentId

string

Required

nodeId

integer

Required

Body Parameters

Collection of DocumentCategoryTypeModel
NameDescriptionTypeAdditional information
id

integer

None.

name

string

None.

friendly_id

string

None.

path

string

None.

category

DocumentCategory

None.

page_number

Collection of integer

None.

document_id

integer

None.

document_reference_id

string

None.

document_name

string

None.

document_path

string

None.

node_id

integer

None.

node_name

string

None.

node_parent_id

integer

None.

status

BatchDocumentCaseStatus

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 1",
    "friendly_id": "sample string 2",
    "path": "sample string 3",
    "category": "AOB",
    "page_number": [
      1,
      2
    ],
    "document_id": 1,
    "document_reference_id": "sample string 4",
    "document_name": "sample string 5",
    "document_path": "sample string 6",
    "node_id": 1,
    "node_name": "sample string 7",
    "node_parent_id": 1,
    "status": "Pending"
  },
  {
    "id": 1,
    "name": "sample string 1",
    "friendly_id": "sample string 2",
    "path": "sample string 3",
    "category": "AOB",
    "page_number": [
      1,
      2
    ],
    "document_id": 1,
    "document_reference_id": "sample string 4",
    "document_name": "sample string 5",
    "document_path": "sample string 6",
    "node_id": 1,
    "node_name": "sample string 7",
    "node_parent_id": 1,
    "status": "Pending"
  }
]

text/html

Sample:
[{"id":1,"name":"sample string 1","friendly_id":"sample string 2","path":"sample string 3","category":"AOB","page_number":[1,2],"document_id":1,"document_reference_id":"sample string 4","document_name":"sample string 5","document_path":"sample string 6","node_id":1,"node_name":"sample string 7","node_parent_id":1,"status":"Pending"},{"id":1,"name":"sample string 1","friendly_id":"sample string 2","path":"sample string 3","category":"AOB","page_number":[1,2],"document_id":1,"document_reference_id":"sample string 4","document_name":"sample string 5","document_path":"sample string 6","node_id":1,"node_name":"sample string 7","node_parent_id":1,"status":"Pending"}]

application/xml, text/xml

Sample:
<ArrayOfDocumentCategoryTypeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
  <DocumentCategoryTypeModel>
    <category>AOB</category>
    <document_id>1</document_id>
    <document_name>sample string 5</document_name>
    <document_path>sample string 6</document_path>
    <document_reference_id>sample string 4</document_reference_id>
    <friendly_id>sample string 2</friendly_id>
    <id>1</id>
    <name>sample string 1</name>
    <node_id>1</node_id>
    <node_name>sample string 7</node_name>
    <node_parent_id>1</node_parent_id>
    <page_number xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </page_number>
    <path>sample string 3</path>
    <status>Pending</status>
  </DocumentCategoryTypeModel>
  <DocumentCategoryTypeModel>
    <category>AOB</category>
    <document_id>1</document_id>
    <document_name>sample string 5</document_name>
    <document_path>sample string 6</document_path>
    <document_reference_id>sample string 4</document_reference_id>
    <friendly_id>sample string 2</friendly_id>
    <id>1</id>
    <name>sample string 1</name>
    <node_id>1</node_id>
    <node_name>sample string 7</node_name>
    <node_parent_id>1</node_parent_id>
    <page_number xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </page_number>
    <path>sample string 3</path>
    <status>Pending</status>
  </DocumentCategoryTypeModel>
</ArrayOfDocumentCategoryTypeModel>

multipart/form-data

Sample:
<ArrayOfDocumentCategoryTypeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><DocumentCategoryTypeModel><category>AOB</category><document_id>1</document_id><document_name>sample string 5</document_name><document_path>sample string 6</document_path><document_reference_id>sample string 4</document_reference_id><friendly_id>sample string 2</friendly_id><id>1</id><name>sample string 1</name><node_id>1</node_id><node_name>sample string 7</node_name><node_parent_id>1</node_parent_id><page_number xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:int>1</d3p1:int><d3p1:int>2</d3p1:int></page_number><path>sample string 3</path><status>Pending</status></DocumentCategoryTypeModel><DocumentCategoryTypeModel><category>AOB</category><document_id>1</document_id><document_name>sample string 5</document_name><document_path>sample string 6</document_path><document_reference_id>sample string 4</document_reference_id><friendly_id>sample string 2</friendly_id><id>1</id><name>sample string 1</name><node_id>1</node_id><node_name>sample string 7</node_name><node_parent_id>1</node_parent_id><page_number xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:int>1</d3p1:int><d3p1:int>2</d3p1:int></page_number><path>sample string 3</path><status>Pending</status></DocumentCategoryTypeModel></ArrayOfDocumentCategoryTypeModel>

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.