DigiOffice Gateway Web Services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

The following routes are available for this service:
POST	/api/documentuploads/registerdocuments

**AddDocumentsForBackgroundRegistration** Parameters:
Name	Parameter	Data Type	Required	Description
Documents	body	List<RegisterDocument>	Yes	List of queued documents to register in background

**RegisterDocument** Parameters:
Name	Parameter	Data Type	Required
RegistrationProfileID	form	Guid	No
Values	form	List<RegistrationValue>	No
Processes	form	List<Process>	No
DocumentUploadId	form	string	No
DocumentId	form	Guid?	No
StandardDocumentID	form	Guid?	No
HasUnsavedChangesInDocument	form	bool?	No
IsOpenedFromNonDMSLocation	form	bool?	No

**RegistrationValue** Parameters:
Name	Parameter	Data Type	Required
Key	form	Guid	No
Value	form	string	No
ShadowValue	form	string	No

**Process** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Title	form	string	No
Description	form	string	No
Note	form	string	No
Coordinator	form	string	No
Urgent	form	bool	No
Transitions	form	List<Transition>	No

**Transition** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
Reason	form	string	No
DelayDate	form	DateTime?	No
DelayReason	form	string	No
UserIDs	form	List<int>	No
GroupIDs	form	List<int>	No

**AddDocumentsForBackgroundRegistrationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
RegisteredDocumentUploads	form	List<RegisteredDocumentUpload>	No

**RegisteredDocumentUpload** Parameters:
Name	Parameter	Data Type	Required
DocumentUploadID	form	int	No
IsSuccess	form	bool	No
Message	form	string	No

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 /api/documentuploads/registerdocuments HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Documents: 
	[
		{
			Values: 
			[
				{
					Value: String,
					ShadowValue: String
				}
			],
			Processes: 
			[
				{
					ID: 0,
					Title: String,
					Description: String,
					Note: String,
					Coordinator: String,
					Urgent: False,
					Transitions: 
					[
						{
							Reason: String,
							DelayDate: 0001-01-01,
							DelayReason: String,
							UserIDs: 
							[
								0
							],
							GroupIDs: 
							[
								0
							]
						}
					]
				}
			],
			DocumentUploadId: String,
			DocumentId: 00000000-0000-0000-0000-000000000000,
			StandardDocumentID: 00000000-0000-0000-0000-000000000000,
			HasUnsavedChangesInDocument: False,
			IsOpenedFromNonDMSLocation: False
		}
	]
}

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

{
	RegisteredDocumentUploads: 
	[
		{
			DocumentUploadID: 0,
			IsSuccess: False,
			Message: String
		}
	]
}