BNN Api

<back to all web services

UploadVScanMedia

Upload a file from a VScan App

The following routes are available for this service:
POST/UploadVScanMediaUpload a file from a VScan App
Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformDatastringNo
JobIdformDataintNo
DocumentNameformDatastringNo
FileformDatafileNo

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/UploadVScanMedia HTTP/1.1 
Host: api.dev.bnn.us 
Content-Type: application/xml
Content-Length: length

<UploadVScanMedia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Requests">
  <AccessToken>String</AccessToken>
  <DocumentName>String</DocumentName>
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.ServiceHost">
    <d2p1:ContentLength>0</d2p1:ContentLength>
    <d2p1:ContentType>String</d2p1:ContentType>
    <d2p1:FileName>String</d2p1:FileName>
    <d2p1:InputStream xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  </File>
  <JobId>0</JobId>
</UploadVScanMedia>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BooleanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Data>false</Data>
</BooleanResponse>