ScannerVision Web Server

<back to all web services

JsonFileUploadRequest

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ScannerVision.WebService.Json.Dto

Namespace Global

    Namespace ScannerVision.WebService.Json.Dto

        Public Partial Class JsonDto
        End Class

        Public Partial Class JsonFileUploadRequest
            Inherits JsonRequestDto
            Public Overridable Property FileName As String
            Public Overridable Property RequestStream As Stream
            Public Overridable Property TemplateGuid As String
        End Class

        Public Partial Class JsonFileUploadResponse
            Inherits JsonDto
            Public Overridable Property ErrorMessage As String
            Public Overridable Property InError As Boolean
            Public Overridable Property TemplateGuid As String
        End Class

        Public Partial Class JsonRequestDto
            Inherits JsonDto
            Public Overridable Property ClientCode As String
            Public Overridable Property ClientRegistrationCode As String
            Public Overridable Property Token As String
        End Class
    End Namespace
End Namespace

VB.NET JsonFileUploadRequest DTOs

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

HTTP + JSV

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

POST /jsv/reply/JsonFileUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FileName: String,
	TemplateGuid: String,
	ClientCode: String,
	ClientRegistrationCode: String,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorMessage: String,
	InError: False,
	TemplateGuid: String
}