DigiOffice Gateway Web Services

<back to all web services

AddFile

Requires Authentication
AddFile Parameters:
NameParameterData TypeRequiredDescription
LinkquerystringNo
BlobIDqueryGuid?No
Sizequeryint?No
IsAttachmentqueryboolNo
DataqueryboolNo
OCRqueryboolNo
PreviewqueryboolNo
TypequerystringNo
DateTimeLastModifiedqueryDateTime?No
MetricHeightqueryint?No
MetricWidthqueryint?No
DocumentIDqueryGuid?No
OriginalFileNamequerystringNo
AddFileResponse Parameters:
NameParameterData TypeRequiredDescription
FileIDformGuidNo

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/AddFile HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.API.DTO.Document.Operations.AddFile, IDB.API.DTO","Link":"String","BlobID":"00000000-0000-0000-0000-000000000000","Size":0,"IsAttachment":false,"Data":false,"OCR":false,"Preview":false,"Type":"String","DateTimeLastModified":"0001-01-01T00:00:00.0000000","MetricHeight":0,"MetricWidth":0,"DocumentID":"00000000-0000-0000-0000-000000000000","OriginalFileName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.API.DTO.Document.Operations.AddFileResponse, IDB.API.DTO","FileID":"00000000-0000-0000-0000-000000000000"}