DigiOffice Gateway Web Services

<back to all web services

GenerateDocumentBatch

Queue multiple (corporate identity) document(s) to generate later via the DigiOffice background agent.

Requires Authentication
GenerateDocumentBatch Parameters:
NameParameterData TypeRequiredDescription
UserqueryUserReferenceNoOwner of the badge (DigiOffice user)
DescriptionquerystringYesDescription of the badge
DocumentsqueryList<BatchDocument>YesCorporate identity document(s) to be generate
DontRegisterqueryboolNoGenerated document is not registered in DigiOffice DMS.
SendMailqueryboolNoSend the generated e-mail via the e-mail queue.
UserReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
LoginNameformstringNo
UserPrincipalNameformstringNo
FullNameformstringNo
EmailAddressformstringNo
GlobalIDformGuid?No
BatchDocument Parameters:
NameParameterData TypeRequiredDescription
ConfigurationSourceformConfigurationSourceYesConfigurationSource: DocumentgeneratorDocument of RegistratieProfiel.
RegistrationMetaDataformRegistrationMetaDataYesSet references to bind with Registration profile
DataSourceEntityformCommonEntityBaseReferenceNoEntity instance used as data source parent, if not exists default is Document registration instance.
CustomDataformstringNoHier kan de (dynamische) data voor het document geplaatst worden, de data kan middels tekstblokken en placeholders worden geplaatst.Het formaat binnen CustomData staat vrij maar vereist een 'root' element.
WatermarkformWatermarkNoInsert a watermark into the document.
OutputTypeformstringNoType van het gegenereerde document, bijvoorbeeld: Doc, Docx, Pdf.
ConfigurationSource Parameters:
NameParameterData TypeRequiredDescription
DocumentgeneratorDocumentformDocumentgeneratorDocumentReferenceNoDocument genereren op basis van een DocGenDocument.
RegistrationProfileformRegistrationProfileReferenceNoDocument genereren op basis van een RegistratieProfiel.
RegisteredDocumentformDocumentReferenceNoUse existing document registration.
DraftDocumentRegistrationformMessageQueueReferenceNoUse draft document registration.
DocumentgeneratorTypeformTypeNo
DocumentgeneratorTypeNameformstringNoDocumentgeneratorType voor bijvoorbeeld Word of Email.
TemplateExtensionformstringNo
OutputExtensionformstringNo
DocumentgeneratorDocumentReference Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
NameformstringNo
GlobalIDformGuid?No
RegistrationProfileReference Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
GlobalIDformGuid?No
DocumentReference Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
CodeformstringNo
VersionCodeformstringNo
RootDocIDformGuid?No
InternalInvoiceCodeformstringNo
CompanyNumberformint?No
DocumentTypeIDformstringNo
InvoiceTypeformint?No
RegProfCatIDformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
ExternNrformstringNo
InternNummerformstringNo
MessageQueueReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
GlobalIDformGuid?No
RegistrationMetaData Parameters:
NameParameterData TypeRequiredDescription
VersioningformVersioningType?NoHoe moet het versiebeheer worden toegepast?
PreviousDocumentformDocumentReferenceNoPrevious document will be used for registration of a new version.
CompanyformCompanyReferenceNoCompany
RelationformRelationReferenceNoRelation
PersonformPersonReferenceNoPerson
ProjectformProjectReferenceNoProject
SubProjectsformList<SubProject>NoSub projects
SignersformList<Signer>NoSigners
FieldsformList<Field>NoBevat velden die gebruikt worden als additionele metadata voor het document, naast de vaste koppelingen zoals gebruiker, project en relatie.
AttachmentsformList<Attachment>NoAttachments die aan de documentregistratie gekoppeld moet worden.
VersioningType Enum:
New
Change
Primary
Secondary
CompanyReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
Numberformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
RelationReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
CreditorNumberformint?No
DebtorNumberformint?No
GlobalLocationNumberformstringNo
GlobalIDformGuid?No
ExternalIDformstringNo
PersonReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
Numberformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
ProjectReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
CodeformstringNo
TypeExternalIDformstringNo
CompanyNumberformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
SubProject Parameters:
NameParameterData TypeRequiredDescription
ProjectformProjectReferenceNo
Signer Parameters:
NameParameterData TypeRequiredDescription
UserformUserReferenceNo
PersonformPersonReferenceNo
RelationformRelationReferenceNo
ContactPersonformContactPersonReferenceNo
RegisteredDocumentformDocumentReferenceNo
TypeformSignerTypeNo
ClosingSentenceformstringNo
NameformstringNo
SubsidiaryformstringNo
FunctionformstringNo
DepartmentformstringNo
PhoneNumberformstringNo
FaxNumberformstringNo
MobileNumberformstringNo
EmailformstringNo
CustomTextformstringNo
SignatureformList<string>No
SignatureVisibleformbool?No
Visibleformbool?No
ContactPersonReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
RelationIDformint?No
PersonIDformint?No
SignerType Enum:
MainSigner
AdditionalSigner
ConfirmationDeclarant
AdditionalConfirmationDeclarant
Field Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
OldValueformstringNo
ValueformstringNo
TitleformstringNo
Attachment Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AttachmentDataformAttachmentDataNo
AttachmentData Parameters:
NameParameterData TypeRequiredDescription
ContentTypeformstringNo
DataformstringNoData base64-encoded zonder padding.
CommonEntityBaseReference Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
ExternalIDformstringNo
GlobalIDformGuid?No
Watermark Parameters:
NameParameterData TypeRequiredDescription
TextformstringNo
FontFamilyTextformstringNo
FontFamilyformFontFamilyNo
DirectionformDirection?No
StrokeColorTextformstringNo
StrokeColorformColorNo
FillColorTextformstringNo
FillColorformColorNo
Direction Enum:
NameValue
Left2Right0
UpLeft2DownRight45
Up2Down90
UpRight2DownLeft135
Right2Left180
DownRight2UpLeft225
Down2Up270
DownLeft2UpRight315
GenerateDocumentBatchResponse Parameters:
NameParameterData TypeRequiredDescription
BatchIDformGuidYesID of the batch
ProcessedformintYesDocument processed count
TrackAndTraceUrlformstringYesTrack and Trace url

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

{"User":{"ID":0,"LoginName":"String","UserPrincipalName":"String","FullName":"String","EmailAddress":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"Description":"String","Documents":[{"ConfigurationSource":{"DocumentgeneratorDocument":{"ID":"00000000-0000-0000-0000-000000000000","Name":"String"},"RegistrationProfile":{},"RegisteredDocument":{"ID":"00000000-0000-0000-0000-000000000000","Code":"String","VersionCode":"String","RootDocID":"00000000-0000-0000-0000-000000000000","InternalInvoiceCode":"String","CompanyNumber":0,"DocumentTypeID":"String","InvoiceType":0,"RegProfCatID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"DraftDocumentRegistration":{"ID":0},"DocumentgeneratorType":null,"TemplateExtension":"String","OutputExtension":"String"},"RegistrationMetaData":{"Versioning":"New","PreviousDocument":{"ID":"00000000-0000-0000-0000-000000000000","Code":"String","VersionCode":"String","RootDocID":"00000000-0000-0000-0000-000000000000","InternalInvoiceCode":"String","CompanyNumber":0,"DocumentTypeID":"String","InvoiceType":0,"RegProfCatID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Company":{"ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Relation":{"ID":0,"CreditorNumber":0,"DebtorNumber":0,"GlobalLocationNumber":"String","GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Person":{"ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Project":{"ID":0,"Code":"String","TypeExternalID":"String","CompanyNumber":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"SubProjects":[{"Project":{"ID":0,"Code":"String","TypeExternalID":"String","CompanyNumber":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"}}],"Signers":[{"User":{"ID":0,"LoginName":"String","UserPrincipalName":"String","FullName":"String","EmailAddress":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"Person":{"ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Relation":{"ID":0,"CreditorNumber":0,"DebtorNumber":0,"GlobalLocationNumber":"String","GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"ContactPerson":{"ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String","RelationID":0,"PersonID":0},"RegisteredDocument":{"ID":"00000000-0000-0000-0000-000000000000","Code":"String","VersionCode":"String","RootDocID":"00000000-0000-0000-0000-000000000000","InternalInvoiceCode":"String","CompanyNumber":0,"DocumentTypeID":"String","InvoiceType":0,"RegProfCatID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Type":"MainSigner","ClosingSentence":"String","Name":"String","Subsidiary":"String","Function":"String","Department":"String","PhoneNumber":"String","FaxNumber":"String","MobileNumber":"String","Email":"String","CustomText":"String","Signature":["String"],"SignatureVisible":false,"Visible":false}],"Fields":[{"Name":"String","OldValue":"String","Value":"String","Title":"String = String -> String"}],"Attachments":[{"Name":"String","AttachmentData":{"ContentType":"String","Data":"String"}}]},"DataSourceEntity":{"ID":"String","ExternalID":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"CustomData":"String","Watermark":{"Text":"String","FontFamilyText":null,"Direction":"Left2Right","StrokeColorText":null,"FillColorText":null},"OutputType":"String"}],"DontRegister":false,"SendMail":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"BatchID":"00000000-0000-0000-0000-000000000000","Processed":0,"TrackAndTraceUrl":"String"}