DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetRegistrationprofileFieldStates
{
    open var RegistrationprofileID:UUID? = null
    open var DocumentID:UUID? = null
    open var QueueDocumentID:Int? = null
    open var StandardDocumentID:UUID? = null
    open var RequestTriggeredByDependentDocumentFieldIds:ArrayList<UUID>? = null
    open var CurrentRegistrationprofileFieldValues:ArrayList<RegistrationProfileFieldValue>? = null
    open var IsOffice365Context:Boolean? = null
    open var IsOpenedFromNonDMSLocation:Boolean? = null
    open var PidTag:String? = null
}

open class RegistrationProfileFieldValue
{
    open var DocumentFieldID:UUID? = null
    open var Value:String? = null
    open var ShadowValue:String? = null
    open var IsModifiedByUser:Boolean? = null
}

open class RegistrationProfileFieldStates
{
    open var ReadOnly:Boolean? = null
    open var Messages:InformationMessages? = null
    open var ControlStates:ArrayList<RegistrationProfileFieldStateBase>? = null
}

open class InformationMessages : ArrayList<InformationMessageBase>(), IInformationMessages
{
}

open class InformationMessageBase : IInformationMessage
{
    override var Type:MessageType? = null
    override var Summary:String? = null
    override var FullMessage:String? = null
    override var FieldName:String? = null
    override var KeepOpen:Boolean? = null
}

enum class MessageType(val value:Int)
{
    Information(1),
    Warning(2),
    Error(3),
    Success(4),
}

open class RegistrationProfileFieldStateBase : FieldState()
{
    open var DocumentFieldID:UUID? = null
}

open class FieldState
{
    open var Required:Boolean? = null
    open var Visible:Boolean? = null
    open var Readonly:Boolean? = null
}

Kotlin GetRegistrationprofileFieldStates DTOs

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: dogw.klokgroep.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
		}
	]
}