ScannerVision Web Server

<back to all web services

JsonFtpMetadataUploadRequest

Requires Authentication
JsonMetadataUploadRequest Parameters:
NameParameterData TypeRequiredDescription
UploadFileNameformstringNo
OriginalFileNameformstringNo
TemplateGuidformstringNo
ClientIpAddressformstringNo
ClientGuidformstringNo
ClientNameformstringNo
ClientIdformstringNo
ClientSerialNumberformstringNo
UserNameformstringNo
UserEmailformstringNo
UserHomeFolderformstringNo
TemplateQuestionsformIDictionary<string, string>No
GlobalQuestionsformIDictionary<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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/JsonFtpMetadataUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

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