ScannerVision Web Server

<back to all web services

JsonMetadataUploadRequest

Requires Authentication
JsonMetadataUploadRequest Parameters:
NameParameterData TypeRequiredDescription
UploadFileNamequerystringNo
OriginalFileNamequerystringNo
TemplateGuidquerystringNo
ClientIpAddressquerystringNo
ClientGuidquerystringNo
ClientNamequerystringNo
ClientIdquerystringNo
ClientSerialNumberquerystringNo
UserNamequerystringNo
UserEmailquerystringNo
UserHomeFolderquerystringNo
TemplateQuestionsqueryIDictionary<string, string>No
GlobalQuestionsqueryIDictionary<string, string>No
JsonRequestDto Parameters:
NameParameterData TypeRequiredDescription
ClientCodeformstringNo
ClientRegistrationCodeformstringNo
TokenformstringNo
JsonMetadataUploadResponse Parameters:
NameParameterData TypeRequiredDescription
TemplateGuidformstringNo
InErrorformboolNo
ErrorMessageformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/JsonMetadataUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UploadFileName":"String","OriginalFileName":"String","TemplateGuid":"String","ClientIpAddress":"String","ClientGuid":"String","ClientName":"String","ClientId":"String","ClientSerialNumber":"String","UserName":"String","UserEmail":"String","UserHomeFolder":"String","ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TemplateGuid":"String","InError":false,"ErrorMessage":"String"}