ScannerVision Web Server

<back to all web services

JsonMetadataUploadRequest

Requires Authentication
namespace ScannerVision.WebService.Json.Dto

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

    [<AllowNullLiteral>]
    type JsonDto() = 
        class end

    [<AllowNullLiteral>]
    type JsonRequestDto() = 
        inherit JsonDto()
        member val ClientCode:String = null with get,set
        member val ClientRegistrationCode:String = null with get,set
        member val Token:String = null with get,set

    [<AllowNullLiteral>]
    type JsonMetadataUploadRequest() = 
        inherit JsonRequestDto()
        member val UploadFileName:String = null with get,set
        member val OriginalFileName:String = null with get,set
        member val TemplateGuid:String = null with get,set
        member val ClientIpAddress:String = null with get,set
        member val ClientGuid:String = null with get,set
        member val ClientName:String = null with get,set
        member val ClientId:String = null with get,set
        member val ClientSerialNumber:String = null with get,set
        member val UserName:String = null with get,set
        member val UserEmail:String = null with get,set
        member val UserHomeFolder:String = null with get,set
        member val TemplateQuestions:IDictionary<String, String> = null with get,set
        member val GlobalQuestions:IDictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type JsonMetadataUploadResponse() = 
        inherit JsonDto()
        member val TemplateGuid:String = null with get,set
        member val InError:Boolean = new Boolean() with get,set
        member val ErrorMessage:String = null with get,set

F# JsonMetadataUploadRequest 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 /xml/reply/JsonMetadataUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JsonMetadataUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientCode>String</ClientCode>
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <Token>String</Token>
  <ClientGuid>String</ClientGuid>
  <ClientId>String</ClientId>
  <ClientIpAddress>String</ClientIpAddress>
  <ClientName>String</ClientName>
  <ClientSerialNumber>String</ClientSerialNumber>
  <GlobalQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OriginalFileName>String</OriginalFileName>
  <TemplateGuid>String</TemplateGuid>
  <TemplateQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <UploadFileName>String</UploadFileName>
  <UserEmail>String</UserEmail>
  <UserHomeFolder>String</UserHomeFolder>
  <UserName>String</UserName>
</JsonMetadataUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonMetadataUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ErrorMessage>String</ErrorMessage>
  <InError>false</InError>
  <TemplateGuid>String</TemplateGuid>
</JsonMetadataUploadResponse>