DigiOffice Gateway Web Services

RegisterDocument

**RegisterDocument** Parameters:
Name	Parameter	Data Type	Required
RegistrationProfileID	query	Guid	No
Values	query	List<RegistrationValue>	No
Processes	query	List<Process>	No
DocumentUploadId	query	string	No
DocumentId	query	Guid?	No
StandardDocumentID	query	Guid?	No
HasUnsavedChangesInDocument	query	bool?	No
IsOpenedFromNonDMSLocation	query	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

**RegisterDocumentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
IsSucces	form	bool	No
DocumentId	form	Guid	No
ErrorMessages	form	List<string>	No
Ooxml	form	string	No
IsCorporateIdentity	form	bool	Yes	Is it a corporate identity document?
DocumentVariables	form	IDictionary<string, string>	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/RegisterDocument HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"__type":"IDB.API.DTO.Document.Operations.RegisterDocument, IDB.API.DTO","RegistrationProfileID":"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]}]}],"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: application/json
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}