| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RegistrationprofileID | query | Guid | No | |
| DocumentID | query | Guid? | No | |
| QueueDocumentID | query | int? | No | |
| StandardDocumentID | query | Guid? | No | |
| RequestTriggeredByDependentDocumentFieldIds | query | List<Guid> | No | |
| CurrentRegistrationprofileFieldValues | query | List<RegistrationProfileFieldValue> | No | |
| IsOffice365Context | query | bool | No | |
| IsOpenedFromNonDMSLocation | query | bool? | No | |
| PidTag | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentFieldID | form | Guid | No | |
| Value | form | string | No | |
| ShadowValue | form | string | No | |
| IsModifiedByUser | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReadOnly | form | bool | No | |
| Messages | form | InformationMessages | No | |
| ControlStates | form | List<RegistrationProfileFieldStateBase> | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentFieldID | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsonl/reply/GetRegistrationprofileFieldStates HTTP/1.1
Host: doapigw.baasbv.nl
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"RegistrationprofileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","QueueDocumentID":0,"StandardDocumentID":"00000000-0000-0000-0000-000000000000","RequestTriggeredByDependentDocumentFieldIds":["00000000-0000-0000-0000-000000000000"],"CurrentRegistrationprofileFieldValues":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IsOffice365Context":false,"IsOpenedFromNonDMSLocation":false,"PidTag":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}