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 .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/UpdateDocumentRegistration HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.API.DTO.Document.Operations.UpdateDocumentRegistration, IDB.API.DTO","DocumentID":"00000000-0000-0000-0000-000000000000","Values":[{"__type":"IDB.API.DTO.Registrationprofile.RegistrationValue, IDB.API.DTO","Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"__type":"IDB.API.DTO.Workflow.Process, IDB.API.DTO","ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"__type":"IDB.API.DTO.Workflow.Transition, IDB.API.DTO","ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"GenerateOoxml":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.API.DTO.Document.Operations.RegisterDocumentResponse, IDB.API.DTO","IsSucces":false,"DocumentId":"00000000-0000-0000-0000-000000000000","ErrorMessages":["String"],"Ooxml":"String","IsCorporateIdentity":false,"DocumentVariables":null}