| 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 .jsv suffix or ?format=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: doapigw.baasbv.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
}