Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentID | query | Guid | No | |
Values | query | List<RegistrationValue> | No | |
Processes | query | List<Process> | No | |
GenerateOoxml | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Key | form | Guid | No | |
Value | form | string | No | |
ShadowValue | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/UpdateDocumentRegistration HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/json
Content-Type: application/json
Content-Length: length
{"DocumentID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"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: application/json Content-Length: length {"IsSucces":false,"DocumentId":"00000000-0000-0000-0000-000000000000","ErrorMessages":["String"],"Ooxml":"String","IsCorporateIdentity":false,"DocumentVariables":null}