ScannerVision Web Server

<back to all web services

BrotherTemplateQuestionResponse

Requires Authentication
The following routes are available for this service:
All Verbs/{Brand}/templates/{TemplateGuid}/submit
namespace ScannerVision.WebService.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type Brand =
        | Desktop = 0
        | Hp = 1
        | Kyocera = 2
        | NeaScan = 3
        | Samsung = 4
        | FujiXerox = 5
        | Ta = 6
        | Utax = 7
        | Epson = 8
        | ScanFront400 = 9
        | Sharp = 10
        | Ricoh = 11
        | FujiFilm = 12
        | Brother = 13

    [<AllowNullLiteral>]
    type DtoBase() = 
        member val Brand:Brand = new Brand() with get,set

    [<AllowNullLiteral>]
    type RequestBase() = 
        inherit DtoBase()

    [<AllowNullLiteral>]
    type QuestionRequestDto() = 
        inherit RequestBase()
        member val TemplateGuid:String = null with get,set
        member val QuestionGuid:String = null with get,set
        member val Parent:String = null with get,set
        member val FolderBrowser:String = null with get,set

    [<AllowNullLiteral>]
    type IClientQuestion = 
        abstract QuestionGuid:String with get,set
        abstract ValueDisplayed:String with get,set
        abstract ValueReturned:String with get,set
        abstract Answered:Boolean with get,set
        abstract RegexMatches:Boolean with get,set
        abstract RegexHint:String with get,set

    [<AllowNullLiteral>]
    type BrotherTemplateQuestionResponse() = 
        inherit QuestionRequestDto()
        member val Question:IClientQuestion = null with get,set

F# BrotherTemplateQuestionResponse DTOs

To override the Content-type in your clients, use the 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 /{Brand}/templates/{TemplateGuid}/submit HTTP/1.1 
Host: dmsshow.kyocerasolutions.cz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BrotherTemplateQuestionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.ServiceModel">
  <Brand>Desktop</Brand>
  <FolderBrowser>String</FolderBrowser>
  <Parent>String</Parent>
  <QuestionGuid>String</QuestionGuid>
  <TemplateGuid>String</TemplateGuid>
  <Question i:nil="true" />
</BrotherTemplateQuestionResponse>