POST api/v1/document/upload
Request Information
URI Parameters
None.
Body Parameters
DocumentUploadRequestMDL| Name | Description | Type | Additional information |
|---|---|---|---|
| VehicleNo | string |
None. |
|
| UploadedBy | integer |
None. |
|
| UploadCompleted | boolean |
None. |
|
| DocumentType | string |
None. |
|
| Files | Collection of DocumentFileMDL |
None. |
Request Formats
application/json, text/json
Sample:
{
"VehicleNo": "sample string 1",
"UploadedBy": 2,
"UploadCompleted": true,
"DocumentType": "sample string 4",
"Files": [
{
"FileName": "sample string 1",
"FileExtension": "sample string 2",
"MimeType": "sample string 3",
"Base64Content": "sample string 4"
},
{
"FileName": "sample string 1",
"FileExtension": "sample string 2",
"MimeType": "sample string 3",
"Base64Content": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<DocumentUploadRequestMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL">
<DocumentType>sample string 4</DocumentType>
<Files>
<DocumentFileMDL>
<Base64Content>sample string 4</Base64Content>
<FileExtension>sample string 2</FileExtension>
<FileName>sample string 1</FileName>
<MimeType>sample string 3</MimeType>
</DocumentFileMDL>
<DocumentFileMDL>
<Base64Content>sample string 4</Base64Content>
<FileExtension>sample string 2</FileExtension>
<FileName>sample string 1</FileName>
<MimeType>sample string 3</MimeType>
</DocumentFileMDL>
</Files>
<UploadCompleted>true</UploadCompleted>
<UploadedBy>2</UploadedBy>
<VehicleNo>sample string 1</VehicleNo>
</DocumentUploadRequestMDL>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DocumentUploadResponseMDL| Name | Description | Type | Additional information |
|---|---|---|---|
| success | boolean |
None. |
|
| errorCode | string |
None. |
|
| uploadId | integer |
None. |
|
| vehicleNo | string |
None. |
|
| status | string |
None. |
|
| uploadCompleted | boolean |
None. |
|
| totalImages | integer |
None. |
|
| pdfGenerated | boolean |
None. |
|
| pdfFileName | string |
None. |
|
| pdfUrl | string |
None. |
|
| message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"errorCode": "sample string 2",
"uploadId": 3,
"vehicleNo": "sample string 4",
"status": "sample string 5",
"uploadCompleted": true,
"totalImages": 7,
"pdfGenerated": true,
"pdfFileName": "sample string 9",
"pdfUrl": "sample string 10",
"message": "sample string 11"
}
application/xml, text/xml
Sample:
<DocumentUploadResponseMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL"> <errorCode>sample string 2</errorCode> <message>sample string 11</message> <pdfFileName>sample string 9</pdfFileName> <pdfGenerated>true</pdfGenerated> <pdfUrl>sample string 10</pdfUrl> <status>sample string 5</status> <success>true</success> <totalImages>7</totalImages> <uploadCompleted>true</uploadCompleted> <uploadId>3</uploadId> <vehicleNo>sample string 4</vehicleNo> </DocumentUploadResponseMDL>