POST api/Documents
Request Information
URI Parameters
None.
Body Parameters
DocumentViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| Name | string |
Required String length: inclusive between 0 and 150 |
|
| CreatedById | string |
None. |
|
| DateCreatedUtc | date |
None. |
|
| DateDeletedUtc | date |
None. |
|
| AllEmployees | boolean |
None. |
|
| Files | Collection of DocumentFileViewModel |
None. |
|
| Recipients | Collection of DocumentRecipientViewModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"Name": "sample string 2",
"CreatedById": "sample string 3",
"DateCreatedUtc": "2026-01-12T09:07:34.6347263+00:00",
"DateDeletedUtc": "2026-01-12T09:07:34.6347263+00:00",
"AllEmployees": true,
"Files": [
{
"Id": "sample string 1",
"DocumentId": "sample string 2",
"FriendlyName": "sample string 3",
"OriginalFileName": "sample string 4",
"Blob": "sample string 5",
"Container": "sample string 6",
"DateCreatedUtc": "2026-01-12T09:07:34.6347263+00:00",
"FileSizeInBytes": 8,
"FileSize": "sample string 9",
"FileName": "sample string 10"
},
{
"Id": "sample string 1",
"DocumentId": "sample string 2",
"FriendlyName": "sample string 3",
"OriginalFileName": "sample string 4",
"Blob": "sample string 5",
"Container": "sample string 6",
"DateCreatedUtc": "2026-01-12T09:07:34.6347263+00:00",
"FileSizeInBytes": 8,
"FileSize": "sample string 9",
"FileName": "sample string 10"
}
],
"Recipients": [
{
"Id": "sample string 1",
"IsNotify": true,
"Name": "sample string 3",
"Bank": "sample string 4",
"AccountType": "sample string 5"
},
{
"Id": "sample string 1",
"IsNotify": true,
"Name": "sample string 3",
"Bank": "sample string 4",
"AccountType": "sample string 5"
}
]
}
application/xml, text/xml
Sample:
<DocumentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NbaVeba.Business.ViewModels.Documents">
<AllEmployees>true</AllEmployees>
<CreatedById>sample string 3</CreatedById>
<DateCreatedUtc>2026-01-12T09:07:34.6347263+00:00</DateCreatedUtc>
<DateDeletedUtc>2026-01-12T09:07:34.6347263+00:00</DateDeletedUtc>
<Files>
<DocumentFileViewModel>
<Blob>sample string 5</Blob>
<Container>sample string 6</Container>
<DateCreatedUtc>2026-01-12T09:07:34.6347263+00:00</DateCreatedUtc>
<DocumentId>sample string 2</DocumentId>
<FileName>sample string 10</FileName>
<FileSize>sample string 9</FileSize>
<FileSizeInBytes>8</FileSizeInBytes>
<FriendlyName>sample string 3</FriendlyName>
<Id>sample string 1</Id>
<OriginalFileName>sample string 4</OriginalFileName>
</DocumentFileViewModel>
<DocumentFileViewModel>
<Blob>sample string 5</Blob>
<Container>sample string 6</Container>
<DateCreatedUtc>2026-01-12T09:07:34.6347263+00:00</DateCreatedUtc>
<DocumentId>sample string 2</DocumentId>
<FileName>sample string 10</FileName>
<FileSize>sample string 9</FileSize>
<FileSizeInBytes>8</FileSizeInBytes>
<FriendlyName>sample string 3</FriendlyName>
<Id>sample string 1</Id>
<OriginalFileName>sample string 4</OriginalFileName>
</DocumentFileViewModel>
</Files>
<Id>sample string 1</Id>
<Name>sample string 2</Name>
<Recipients>
<DocumentRecipientViewModel>
<AccountType>sample string 5</AccountType>
<Bank>sample string 4</Bank>
<Id>sample string 1</Id>
<IsNotify>true</IsNotify>
<Name>sample string 3</Name>
</DocumentRecipientViewModel>
<DocumentRecipientViewModel>
<AccountType>sample string 5</AccountType>
<Bank>sample string 4</Bank>
<Id>sample string 1</Id>
<IsNotify>true</IsNotify>
<Name>sample string 3</Name>
</DocumentRecipientViewModel>
</Recipients>
</DocumentViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.