DigiOffice Gateway Web Services

<back to all web services

AddDocument

Requires Authentication
AddDocument Parameters:
NameParameterData TypeRequiredDescription
RegistrationProfileIDqueryGuidNo
DocumentIDqueryGuid?No
RootDocumentIDqueryGuid?No
AssignToUserIDqueryint?No
AssignToGroupIDqueryint?No
MetaDataqueryList<MetaDataField>No
MailingsqueryMailingsNo
AttachmentsMailingsqueryList<AttachmentMailing>No
FileIDqueryGuid?No
SilentModequeryDocInfoSilentModeNo
updateStorageSystemqueryboolNo
MessageQueueIdqueryint?No
MetaDataField Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
DocumentVeldIDformGuid?No
NameformstringNo
LabelformstringNo
DatatypeformstringNo
PrintLabelformstringNo
EntityformstringNo
PrintValueformstringNo
RegistrationValueformstringNo
SPSiteColumnNameformstringNo
ShadowNameformstringNo
ShadowDatatypeformstringNo
ShadowSPSiteColumnNameformstringNo
ShadowSPSiteColumnRegistrationValueformstringNo
ShadowRegistrationValueformstringNo
IsKeyFieldformboolNo
KopierenBijNieuweVersieformboolNo
DocInfoSilentMode Enum:
Off
AllowUserInteraction
DoNotAllowUserInteraction
DocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformGuidNo
DocumentNrformstringNo
RootDocumentIDformGuidNo
MetaDataformList<MetaDataField>No
BookmarksformList<Bookmark>No
MailingsformMailingsNo
AttachmentsMailingsformList<AttachmentMailing>No
MessagesformIInformationMessagesNo
SourceDocumentPathformstringNo
DestinationDocumentPathformstringNo
SharePointContentTypeNameformstringNo
ZIPAttachmentsformboolNo
Bookmark Parameters:
NameParameterData TypeRequiredDescription
RemoveLastBreakformbool?No
ReplaceOnChangeformboolNo
IsDynamicformboolNo

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/AddDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","AssignToUserID":0,"AssignToGroupID":0,"MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Mailings":{},"AttachmentsMailings":[{}],"FileID":"00000000-0000-0000-0000-000000000000","SilentMode":"Off","updateStorageSystem":false,"MessageQueueId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","DocumentNr":"String","RootDocumentID":"00000000-0000-0000-0000-000000000000","MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Bookmarks":[{"RemoveLastBreak":false,"ReplaceOnChange":false,"IsDynamic":false}],"Mailings":{},"AttachmentsMailings":[{}],"Messages":null,"SourceDocumentPath":"String","DestinationDocumentPath":"String","SharePointContentTypeName":"String","ZIPAttachments":false}