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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/GetMultiRegistrationProfileFieldStates HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MultiRegistrationProfileFieldStates: 
	[
		{
			DocumentID: 00000000-0000-0000-0000-000000000000,
			QueueDocumentID: 0,
			StandardDocumentID: 00000000-0000-0000-0000-000000000000,
			RequestTriggeredByDependentDocumentFieldIds: 
			[
				00000000-0000-0000-0000-000000000000
			],
			CurrentRegistrationprofileFieldValues: 
			[
				{
					Value: String,
					ShadowValue: String,
					IsModifiedByUser: False
				}
			],
			IsOffice365Context: False,
			IsOpenedFromNonDMSLocation: False,
			PidTag: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		DocumentUploadID: 0,
		ReadOnly: False,
		Messages: 
		[
			{
				
			}
		],
		ControlStates: 
		[
			{
				Required: False,
				Visible: False,
				Readonly: False
			}
		]
	}
]