DigiOffice Gateway Web Services

GetRegistrationprofileFieldStates

**GetRegistrationprofileFieldStates** Parameters:
Name	Parameter	Data Type	Required
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

**RegistrationProfileFieldValue** Parameters:
Name	Parameter	Data Type	Required
DocumentFieldID	form	Guid	No
Value	form	string	No
ShadowValue	form	string	No
IsModifiedByUser	form	bool	No

**RegistrationProfileFieldStates** Parameters:
Name	Parameter	Data Type	Required
ReadOnly	form	bool	No
Messages	form	InformationMessages	No
ControlStates	form	List<RegistrationProfileFieldStateBase>	No
DependentFieldsControlStates	form	List<RegistrationProfileFieldStateBase>	No

**InformationMessageBase** Parameters:
Name	Parameter	Data Type	Required
Type	form	MessageType	No
Summary	form	string	No
FullMessage	form	string	No
FieldName	form	string	No
KeepOpen	form	bool	No

**MessageType** Enum:
Name	Value
Information	1
Warning	2
Error	3
Success	4

**RegistrationProfileFieldStateBase** Parameters:
Name	Parameter	Data Type	Required
DocumentFieldID	form	Guid	No
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 .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/GetRegistrationprofileFieldStates HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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

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