ScannerVision Web Server

<back to all web services

WebClientPicklistRequest

Requires Authentication
The following routes are available for this service:
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/search/{SearchTerm}
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/{Path}
GET/{Brand}/browse/{TemplateGuid}/{QuestionGuid}/{PicklistGuid}/{Path}/search/{SearchTerm}
All Verbs/{Brand}/browse/{BrowseType}/
All Verbs/{Brand}/browse/{BrowseType}/
All Verbs/{Brand}/browse/{BrowseType}/{Path}
All Verbs/{Brand}/browse/{BrowseType}/{Path}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ScannerVision.WebService.ServiceModel

Namespace Global

    Namespace ScannerVision.WebService.ServiceModel

        Public Enum Brand
            Desktop
            Hp
            Kyocera
            NeaScan
            Samsung
            FujiXerox
            Ta
            Utax
            Epson
            ScanFront400
            Sharp
            Ricoh
            FujiFilm
        End Enum

        Public Partial Class BrowsePicklistRequest
            Inherits BrowseRequest
            Public Overridable Property PicklistGuid As String
            Public Overridable Property Answers As IDictionary(Of String, String)
        End Class

        Public Partial Class BrowseRequest
            Inherits RequestBase
            Public Overridable Property Path As String
        End Class

        Public Partial Class DtoBase
            Public Overridable Property Brand As Brand
        End Class

        Public Partial Class RequestBase
            Inherits DtoBase
        End Class

        Public Partial Class WebClientPicklistRequest
            Inherits BrowsePicklistRequest
            Public Overridable Property TemplateGuid As String
            Public Overridable Property QuestionGuid As String
            Public Overridable Property SearchTerm As String
        End Class
    End Namespace
End Namespace

VB.NET WebClientPicklistRequest DTOs

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

HTTP + OTHER

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

POST /{Brand}/browse/{BrowseType}/ HTTP/1.1 
Host: buildmax.org 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TemplateGuid":"String","QuestionGuid":"String","SearchTerm":"String","PicklistGuid":"String","Path":"String","Brand":"Desktop"}