DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Registrationprofile.Operations
Imports IDB.API.DTO.Registrationprofile
Imports IDB.Diagnostics
Imports IDB.Core.Diagnostics.Interfaces
Imports IDB.Core.Diagnostics

Namespace Global

    Namespace IDB.API.DTO.Registrationprofile

        Public Partial Class RegistrationProfileFieldStateBase
            Public Overridable Property DocumentFieldID As Guid
            Public Overridable Property Required As Boolean
            Public Overridable Property Visible As Boolean
            Public Overridable Property Readonly As Boolean
        End Class

        Public Partial Class RegistrationProfileFieldStates
            Public Sub New()
                ControlStates = New List(Of RegistrationProfileFieldStateBase)
                DependentFieldsControlStates = New List(Of RegistrationProfileFieldStateBase)
            End Sub

            Public Overridable Property ReadOnly As Boolean
            Public Overridable Property Messages As InformationMessages
            Public Overridable Property ControlStates As List(Of RegistrationProfileFieldStateBase)
            Public Overridable Property DependentFieldsControlStates As List(Of RegistrationProfileFieldStateBase)
        End Class

        Public Partial Class RegistrationProfileFieldValue
            Public Overridable Property DocumentFieldID As Guid
            Public Overridable Property Value As String
            Public Overridable Property ShadowValue As String
            Public Overridable Property IsModifiedByUser As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DTO.Registrationprofile.Operations

        Public Partial Class GetRegistrationprofileFieldStates
            Public Sub New()
                RequestTriggeredByDependentDocumentFieldIds = New List(Of Guid)
                CurrentRegistrationprofileFieldValues = New List(Of RegistrationProfileFieldValue)
            End Sub

            Public Overridable Property RegistrationprofileID As Guid
            Public Overridable Property DocumentID As Nullable(Of Guid)
            Public Overridable Property QueueDocumentID As Nullable(Of Integer)
            Public Overridable Property StandardDocumentID As Nullable(Of Guid)
            Public Overridable Property RequestTriggeredByDependentDocumentFieldIds As List(Of Guid)
            Public Overridable Property CurrentRegistrationprofileFieldValues As List(Of RegistrationProfileFieldValue)
            Public Overridable Property IsOffice365Context As Boolean
            Public Overridable Property IsOpenedFromNonDMSLocation As Nullable(Of Boolean)
            Public Overridable Property PidTag As String
        End Class
    End Namespace

    Namespace IDB.Core.Diagnostics

        Public Enum MessageType
            Information = 1
            Warning = 2
            [Error] = 3
            Success = 4
        End Enum
    End Namespace

    Namespace IDB.Core.Diagnostics.Interfaces

        Public Partial Class InformationMessageBase
            Implements IInformationMessage
            Public Overridable Property Type As MessageType
            Public Overridable Property Summary As String
            Public Overridable Property FullMessage As String
            Public Overridable Property FieldName As String
            Public Overridable Property KeepOpen As Boolean
        End Class
    End Namespace

    Namespace IDB.Diagnostics

        Public Partial Class InformationMessages
            Inherits List(Of InformationMessageBase)
            Implements IInformationMessages
        End Class
    End Namespace
End Namespace

VB.NET 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: 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
		}
	]
}