DigiOffice Gateway Web Services

GenerateDocumentBatch

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

**GenerateDocumentBatch** Parameters:
Name	Parameter	Data Type	Required	Description
User	query	UserReference	No	Owner of the badge (DigiOffice user)
Description	query	string	Yes	Description of the badge
Documents	query	List<BatchDocument>	Yes	Corporate identity document(s) to be generate
DontRegister	query	bool	No	Generated document is not registered in DigiOffice DMS.
SendMail	query	bool	No	Send the generated e-mail via the e-mail queue.

**UserReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	int?	No
LoginName	form	string	No
UserPrincipalName	form	string	No
FullName	form	string	No
EmailAddress	form	string	No
GlobalID	form	Guid?	No

**BatchDocument** Parameters:
Name	Parameter	Data Type	Required	Description
ConfigurationSource	form	ConfigurationSource	Yes	ConfigurationSource: DocumentgeneratorDocument of RegistratieProfiel.
RegistrationMetaData	form	RegistrationMetaData	Yes	Set references to bind with Registration profile
DataSourceEntity	form	CommonEntityBaseReference	No	Entity instance used as data source parent, if not exists default is Document registration instance.
CustomData	form	string	No	Hier 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.
Watermark	form	Watermark	No	Insert a watermark into the document.
OutputType	form	string	No	Type van het gegenereerde document, bijvoorbeeld: Doc, Docx, Pdf.

**ConfigurationSource** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentgeneratorDocument	form	DocumentgeneratorDocumentReference	No	Document genereren op basis van een DocGenDocument.
RegistrationProfile	form	RegistrationProfileReference	No	Document genereren op basis van een RegistratieProfiel.
RegisteredDocument	form	DocumentReference	No	Use existing document registration.
DraftDocumentRegistration	form	MessageQueueReference	No	Use draft document registration.
DocumentgeneratorType	form	Type	No
DocumentgeneratorTypeName	form	string	No	DocumentgeneratorType voor bijvoorbeeld Word of Email.
TemplateExtension	form	string	No
OutputExtension	form	string	No

**DocumentgeneratorDocumentReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid?	No
Name	form	string	No
GlobalID	form	Guid?	No

**RegistrationProfileReference** Parameters:
Name	Parameter	Data Type	Required	Description
ID	form	Guid	No
GlobalID	form	Guid?	No

**DocumentReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid?	No
Code	form	string	No
VersionCode	form	string	No
RootDocID	form	Guid?	No
InternalInvoiceCode	form	string	No
CompanyNumber	form	int?	No
DocumentTypeID	form	string	No
InvoiceType	form	int?	No
RegProfCatID	form	int?	No
GlobalID	form	Guid?	No
ExternalID	form	string	No
ExternNr	form	string	No
InternNummer	form	string	No

**MessageQueueReference** Parameters:
Name	Parameter	Data Type	Required	Description
ID	form	int?	No
GlobalID	form	Guid?	No

**RegistrationMetaData** Parameters:
Name	Parameter	Data Type	Required	Description
Versioning	form	VersioningType?	No	Hoe moet het versiebeheer worden toegepast?
PreviousDocument	form	DocumentReference	No	Previous document will be used for registration of a new version.
Company	form	CompanyReference	No	Company
Relation	form	RelationReference	No	Relation
Person	form	PersonReference	No	Person
Project	form	ProjectReference	No	Project
SubProjects	form	List<SubProject>	No	Sub projects
Signers	form	List<Signer>	No	Signers
Fields	form	List<Field>	No	Bevat velden die gebruikt worden als additionele metadata voor het document, naast de vaste koppelingen zoals gebruiker, project en relatie.
Attachments	form	List<Attachment>	No	Attachments die aan de documentregistratie gekoppeld moet worden.

**CompanyReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	int?	No
Number	form	int?	No
GlobalID	form	Guid?	No
ExternalID	form	string	No

**RelationReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	int?	No
CreditorNumber	form	int?	No
DebtorNumber	form	int?	No
GlobalLocationNumber	form	string	No
GlobalID	form	Guid?	No
ExternalID	form	string	No

**PersonReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	int?	No
Number	form	int?	No
GlobalID	form	Guid?	No
ExternalID	form	string	No

**ProjectReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	int?	No
Code	form	string	No
TypeExternalID	form	string	No
CompanyNumber	form	int?	No
GlobalID	form	Guid?	No
ExternalID	form	string	No

**SubProject** Parameters:
Name	Parameter	Data Type	Required	Description
Project	form	ProjectReference	No

**Signer** Parameters:
Name	Parameter	Data Type	Required
User	form	UserReference	No
Person	form	PersonReference	No
Relation	form	RelationReference	No
ContactPerson	form	ContactPersonReference	No
RegisteredDocument	form	DocumentReference	No
Type	form	SignerType	No
ClosingSentence	form	string	No
Name	form	string	No
Subsidiary	form	string	No
Function	form	string	No
Department	form	string	No
PhoneNumber	form	string	No
FaxNumber	form	string	No
MobileNumber	form	string	No
Email	form	string	No
CustomText	form	string	No
Signature	form	List<string>	No
SignatureVisible	form	bool?	No
Visible	form	bool?	No

**ContactPersonReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	int?	No
GlobalID	form	Guid?	No
ExternalID	form	string	No
RelationID	form	int?	No
PersonID	form	int?	No

**Field** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
OldValue	form	string	No
Value	form	string	No
Title	form	string	No

**Attachment** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
AttachmentData	form	AttachmentData	No

**AttachmentData** Parameters:
Name	Parameter	Data Type	Required	Description
ContentType	form	string	No
Data	form	string	No	Data base64-encoded zonder padding.

**CommonEntityBaseReference** Parameters:
Name	Parameter	Data Type	Required
ID	form	string	No
ExternalID	form	string	No
GlobalID	form	Guid?	No

**Watermark** Parameters:
Name	Parameter	Data Type	Required
Text	form	string	No
FontFamilyText	form	string	No
FontFamily	form	FontFamily	No
Direction	form	Direction?	No
StrokeColorText	form	string	No
StrokeColor	form	Color	No
FillColorText	form	string	No
FillColor	form	Color	No

**GenerateDocumentBatchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
BatchID	form	Guid	Yes	ID of the batch
Processed	form	int	Yes	Document processed count
TrackAndTraceUrl	form	string	Yes	Track and Trace url

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

HTTP + JSV

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

POST /jsv/reply/GenerateDocumentBatch HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.DocumentGenerator.SDK.Operations.General.GenerateDocumentBatch, IDB.DocumentGenerator.SDK",
	User: 
	{
		__type: "IDB.API.Entities.UserReference, IDB.API",
		ID: 0,
		LoginName: String,
		UserPrincipalName: String,
		FullName: String,
		EmailAddress: String,
		GlobalID: 00000000-0000-0000-0000-000000000000
	},
	Description: String,
	Documents: 
	[
		{
			__type: "IDB.DocumentGenerator.SDK.DTO.BatchDocument, IDB.DocumentGenerator.SDK",
			ConfigurationSource: 
			{
				__type: "IDB.API.DocumentGenerator.ConfigurationSource, IDB.API",
				DocumentgeneratorDocument: 
				{
					__type: "IDB.API.Entities.DocumentgeneratorDocumentReference, IDB.API",
					ID: 00000000-0000-0000-0000-000000000000,
					Name: String
				},
				RegistrationProfile: 
				{
					__type: "IDB.API.Entities.RegistrationProfileReference, IDB.API"
				},
				RegisteredDocument: 
				{
					__type: "IDB.API.Entities.DocumentReference, IDB.API",
					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: 
				{
					__type: "IDB.API.Entities.MessageQueueReference, IDB.API",
					ID: 0
				},
				TemplateExtension: String,
				OutputExtension: String
			},
			RegistrationMetaData: 
			{
				__type: "IDB.DocumentGenerator.SDK.DTO.RegistrationMetaData, IDB.DocumentGenerator.SDK",
				Versioning: New,
				PreviousDocument: 
				{
					__type: "IDB.API.Entities.DocumentReference, IDB.API",
					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: 
				{
					__type: "IDB.API.Entities.CompanyReference, IDB.API",
					ID: 0,
					Number: 0,
					GlobalID: 00000000-0000-0000-0000-000000000000,
					ExternalID: String
				},
				Relation: 
				{
					__type: "IDB.API.Entities.RelationReference, IDB.API",
					ID: 0,
					CreditorNumber: 0,
					DebtorNumber: 0,
					GlobalLocationNumber: String,
					GlobalID: 00000000-0000-0000-0000-000000000000,
					ExternalID: String
				},
				Person: 
				{
					__type: "IDB.API.Entities.PersonReference, IDB.API",
					ID: 0,
					Number: 0,
					GlobalID: 00000000-0000-0000-0000-000000000000,
					ExternalID: String
				},
				Project: 
				{
					__type: "IDB.API.Entities.ProjectReference, IDB.API",
					ID: 0,
					Code: String,
					TypeExternalID: String,
					CompanyNumber: 0,
					GlobalID: 00000000-0000-0000-0000-000000000000,
					ExternalID: String
				},
				SubProjects: 
				[
					{
						__type: "IDB.API.DocumentGenerator.SubProject, IDB.API",
						Project: 
						{
							__type: "IDB.API.Entities.ProjectReference, IDB.API",
							ID: 0,
							Code: String,
							TypeExternalID: String,
							CompanyNumber: 0,
							GlobalID: 00000000-0000-0000-0000-000000000000,
							ExternalID: String
						}
					}
				],
				Signers: 
				[
					{
						__type: "IDB.API.DocumentGenerator.Signer, IDB.API",
						User: 
						{
							__type: "IDB.API.Entities.UserReference, IDB.API",
							ID: 0,
							LoginName: String,
							UserPrincipalName: String,
							FullName: String,
							EmailAddress: String,
							GlobalID: 00000000-0000-0000-0000-000000000000
						},
						Person: 
						{
							__type: "IDB.API.Entities.PersonReference, IDB.API",
							ID: 0,
							Number: 0,
							GlobalID: 00000000-0000-0000-0000-000000000000,
							ExternalID: String
						},
						Relation: 
						{
							__type: "IDB.API.Entities.RelationReference, IDB.API",
							ID: 0,
							CreditorNumber: 0,
							DebtorNumber: 0,
							GlobalLocationNumber: String,
							GlobalID: 00000000-0000-0000-0000-000000000000,
							ExternalID: String
						},
						ContactPerson: 
						{
							__type: "IDB.API.Entities.ContactPersonReference, IDB.API",
							ID: 0,
							GlobalID: 00000000-0000-0000-0000-000000000000,
							ExternalID: String,
							RelationID: 0,
							PersonID: 0
						},
						RegisteredDocument: 
						{
							__type: "IDB.API.Entities.DocumentReference, IDB.API",
							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: 
				[
					{
						__type: "IDB.API.Common.Field, IDB.API",
						Name: String,
						OldValue: String,
						Value: String,
						Title: String = String -> String
					}
				],
				Attachments: 
				[
					{
						__type: "IDB.API.DocumentGenerator.Attachment, IDB.API",
						Name: String,
						AttachmentData: 
						{
							__type: "IDB.API.DocumentGenerator.AttachmentData, IDB.API",
							ContentType: String,
							Data: String
						}
					}
				]
			},
			DataSourceEntity: 
			{
				__type: "IDB.API.Entities.CommonEntityBaseReference, IDB.API",
				ID: String,
				ExternalID: String,
				GlobalID: 00000000-0000-0000-0000-000000000000
			},
			CustomData: String,
			Watermark: 
			{
				__type: "IDB.API.DocumentGenerator.Watermark, IDB.API",
				Text: String,
				Direction: Left2Right
			},
			OutputType: String
		}
	],
	DontRegister: False,
	SendMail: False
}

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

{
	__type: "IDB.DocumentGenerator.SDK.DTO.General.GenerateDocumentBatchResponse, IDB.DocumentGenerator.SDK",
	Processed: 0,
	TrackAndTraceUrl: String
}