DigiOffice Gateway Web Services

<back to all web services

GetMultiRegistrationProfileFieldStates

Requires Authentication
GetMultiRegistrationProfileFieldStates Parameters:
NameParameterData TypeRequiredDescription
MultiRegistrationProfileFieldStatesqueryList<GetRegistrationprofileFieldStates>No
GetRegistrationprofileFieldStates Parameters:
NameParameterData TypeRequiredDescription
RegistrationprofileIDformGuidNo
DocumentIDformGuid?No
QueueDocumentIDformint?No
StandardDocumentIDformGuid?No
RequestTriggeredByDependentDocumentFieldIdsformList<Guid>No
CurrentRegistrationprofileFieldValuesformList<RegistrationProfileFieldValue>No
IsOffice365ContextformboolNo
IsOpenedFromNonDMSLocationformbool?No
PidTagformstringNo
RegistrationProfileFieldValue Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
ValueformstringNo
ShadowValueformstringNo
IsModifiedByUserformboolNo

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/GetMultiRegistrationProfileFieldStates HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"MultiRegistrationProfileFieldStates":[{"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

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