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
RegistrationProfileFieldValue Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
ValueformstringNo
ShadowValueformstringNo
IsModifiedByUserformboolNo
RegistrationProfileFieldStates Parameters:
NameParameterData TypeRequiredDescription
ReadOnlyformboolNo
MessagesformInformationMessagesNo
ControlStatesformList<RegistrationProfileFieldStateBase>No
InformationMessageBase Parameters:
NameParameterData TypeRequiredDescription
TypeformMessageTypeNo
SummaryformstringNo
FullMessageformstringNo
FieldNameformstringNo
KeepOpenformboolNo
RegistrationProfileFieldStateBase Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
RequiredformboolNo
VisibleformboolNo
ReadonlyformboolNo

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: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Registrationprofile.Operations.GetRegistrationprofileFieldStates, IDB.API.DTO",
	DocumentID: 00000000-0000-0000-0000-000000000000,
	QueueDocumentID: 0,
	StandardDocumentID: 00000000-0000-0000-0000-000000000000,
	RequestTriggeredByDependentDocumentFieldIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	CurrentRegistrationprofileFieldValues: 
	[
		{
			__type: "IDB.API.DTO.Registrationprofile.RegistrationProfileFieldValue, IDB.API.DTO",
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	],
	IsOffice365Context: False,
	IsOpenedFromNonDMSLocation: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Registrationprofile.RegistrationProfileFieldStates, IDB.API.DTO",
	ReadOnly: False,
	Messages: 
	[
		{
			
		}
	],
	ControlStates: 
	[
		{
			__type: "IDB.API.DTO.Registrationprofile.RegistrationProfileFieldStateBase, IDB.API.DTO",
			Required: False,
			Visible: False,
			Readonly: False
		}
	]
}