Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PidTag | query | string | 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 .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/GetRegistrationProfileDetailsFromEmailDraft HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/json
Content-Type: application/json
Content-Length: length
{"PidTag":"String","IsOffice365Context":false}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Steps":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Order":0,"Layout":"OneColumn_12","Groups":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Order":0,"ColumnIndex":0,"Fields":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Label":"String","UserControlType":"String","UserControlProperties":[{}],"Hint":"String","Order":0,"HasDependableFields":false,"EntityName":"String","State":{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}}],"LabelLayoutType":0}]}],"Messages":[{}],"ReadOnly":false,"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Hint":"String","Order":0,"RegisterAutomatically":false,"RegisterInBackground":false,"ThumbnailUrl":"String","ProgCode":"String","VersionControlType":0,"WOPlaceLogo":0,"WOPrinterBins":"String","SelectAllFiles":false}