Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RegistrationProfileID | query | Guid | No | |
Values | query | List<RegistrationValue> | No | |
Processes | query | List<Process> | No | |
DocumentUploadId | query | string | No | |
MessageQueueId | query | string | No | |
ReplyEmailHtml | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PidTag | form | string | No | |
ItemId | form | string | No | |
EwsUrl | form | string | No | |
Token | form | string | 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 |
---|---|---|---|---|
DocumentId | form | Guid | No | |
EmailHtml | form | string | No | |
IsRegistered | form | bool | No | |
DocumentNr | form | string | No | |
Values | form | List<RegistrationProfileFieldStateBase> | No | |
RegistrationProfileID | form | Guid | No | |
RegisterAutomatically | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentFieldID | form | Guid | No | |
Required | form | bool | No | |
Visible | form | bool | No | |
Readonly | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/CreateDraftCorporateIdentityMail HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RegistrationProfileID":"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]}]}],"DocumentUploadId":"String","MessageQueueId":"String","ReplyEmailHtml":"String","PidTag":"String","ItemId":"String","EwsUrl":"String","Token":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"DocumentId":"00000000-0000-0000-0000-000000000000","EmailHtml":"String","IsRegistered":false,"DocumentNr":"String","Values":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","RegisterAutomatically":false}