Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentID | query | Guid | No | |
QueueDocumentId | query | int | No | |
IsOffice365Context | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Steps | form | List<RegistrationprofileStep> | No | |
Messages | form | List<InformationMessageBase> | No | |
ReadOnly | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | Guid | No | |
Name | form | string | No | |
Hint | form | string | No | |
Order | form | int | No | |
RegisterAutomatically | form | bool | No | |
RegisterInBackground | form | bool | No | |
ThumbnailUrl | form | string | No | |
ProgCode | form | string | No | |
VersionControlType | form | int | No | |
WOPlaceLogo | form | int | No | |
WOPrinterBins | form | string | No | |
SelectAllFiles | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | Guid | No | |
Name | form | string | No | |
Order | form | int | No | |
Layout | form | RegistrationprofileStepLayout | No | |
Groups | form | List<RegistrationprofileGroup> | No |
OneColumn_12 | |
TwoColumn_6_6 | |
TwoColumn_7_5 | |
ThreeColumn_4_4_4 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | Guid | No | |
Name | form | string | No | |
Label | form | string | No | |
Order | form | int | No | |
ColumnIndex | form | int | No | |
Fields | form | List<RegistrationprofileField> | No | |
LabelLayoutType | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | Guid | No | |
DocumentFieldID | form | Guid | No | |
Label | form | string | No | |
UserControlType | form | string | No | |
UserControlProperties | form | List<SerializableKeyValuePair<String,Object>> | No | |
Hint | form | string | No | |
Order | form | int | No | |
HasDependableFields | form | bool | No | |
EntityName | form | string | No | |
State | form | RegistrationProfileFieldStateBase | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentFieldID | form | Guid | No | |
Required | form | bool | No | |
Visible | form | bool | No | |
Readonly | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | MessageType | No | |
Summary | form | string | No | |
FullMessage | form | string | No | |
FieldName | form | string | No | |
KeepOpen | form | bool | No |
Name | Value | |
---|---|---|
Information | 1 | |
Warning | 2 | |
Error | 3 | |
Success | 4 |
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/GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
QueueDocumentId: 0,
IsOffice365Context: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Steps: [ { Name: String, Order: 0, Layout: OneColumn_12, Groups: [ { Name: String, Label: String, Order: 0, ColumnIndex: 0, Fields: [ { Label: String, UserControlType: String, UserControlProperties: [ { } ], Hint: String, Order: 0, HasDependableFields: False, EntityName: String, State: { Required: False, Visible: False, Readonly: False } } ], LabelLayoutType: 0 } ] } ], Messages: [ { } ], ReadOnly: False, Name: String, Hint: String, Order: 0, RegisterAutomatically: False, RegisterInBackground: False, ThumbnailUrl: String, ProgCode: String, VersionControlType: 0, WOPlaceLogo: 0, WOPrinterBins: String, SelectAllFiles: False }