DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
GetRegistrationprofileFieldStates Parameters:
NameParameterData TypeRequiredDescription
RegistrationprofileIDqueryGuidNo
DocumentIDqueryGuid?No
QueueDocumentIDqueryint?No
StandardDocumentIDqueryGuid?No
RequestTriggeredByDependentDocumentFieldIdsqueryList<Guid>No
CurrentRegistrationprofileFieldValuesqueryList<RegistrationProfileFieldValue>No
IsOffice365ContextqueryboolNo
IsOpenedFromNonDMSLocationquerybool?No
PidTagquerystringNo
RegistrationProfileFieldValue Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
ValueformstringNo
ShadowValueformstringNo
IsModifiedByUserformboolNo
RegistrationProfileFieldStates Parameters:
NameParameterData TypeRequiredDescription
ReadOnlyformboolNo
MessagesformInformationMessagesNo
ControlStatesformList<RegistrationProfileFieldStateBase>No
DependentFieldsControlStatesformList<RegistrationProfileFieldStateBase>No
InformationMessageBase Parameters:
NameParameterData TypeRequiredDescription
TypeformMessageTypeNo
SummaryformstringNo
FullMessageformstringNo
FieldNameformstringNo
KeepOpenformboolNo
MessageType Enum:
NameValue
Information1
Warning2
Error3
Success4
RegistrationProfileFieldStateBase Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
RequiredformboolNo
VisibleformboolNo
ReadonlyformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"DependentFieldsControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}