DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

Requires Authentication
UpdateDocumentRegistration Parameters:
NameParameterData TypeRequiredDescription
DocumentIDqueryGuidNo
ValuesqueryList<RegistrationValue>No
ProcessesqueryList<Process>No
GenerateOoxmlqueryboolNo
RegistrationValue Parameters:
NameParameterData TypeRequiredDescription
KeyformGuidNo
ValueformstringNo
ShadowValueformstringNo
Process Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
DescriptionformstringNo
NoteformstringNo
CoordinatorformstringNo
UrgentformboolNo
TransitionsformList<Transition>No
Transition Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
ReasonformstringNo
DelayDateformDateTime?No
DelayReasonformstringNo
UserIDsformList<int>No
GroupIDsformList<int>No
RegisterDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
IsSuccesformboolNo
DocumentIdformGuidNo
ErrorMessagesformList<string>No
OoxmlformstringNo
IsCorporateIdentityformboolYesIs it a corporate identity document?
DocumentVariablesformIDictionary<string, 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 /jsv/reply/UpdateDocumentRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
					]
				}
			]
		}
	],
	GenerateOoxml: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsSucces: False,
	ErrorMessages: 
	[
		String
	],
	Ooxml: String,
	IsCorporateIdentity: False
}