DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

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


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

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

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

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

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

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

open class RegistrationProfileFieldStateBase
{
    var DocumentFieldID:UUID? = null
    var Required:Boolean? = null
    var Visible:Boolean? = null
    var Readonly:Boolean? = null
}

Kotlin GetRegistrationprofileFieldStates DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetRegistrationprofileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile.Operations">
  <CurrentRegistrationprofileFieldValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldValue>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationProfileFieldValue>
  </CurrentRegistrationprofileFieldValues>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <IsOffice365Context>false</IsOffice365Context>
  <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
  <PidTag>String</PidTag>
  <QueueDocumentID>0</QueueDocumentID>
  <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
  <RequestTriggeredByDependentDocumentFieldIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RequestTriggeredByDependentDocumentFieldIds>
  <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
</GetRegistrationprofileFieldStates>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
  <ControlStates>
    <RegistrationProfileFieldStateBase>
      <DocumentFieldID>00000000-0000-0000-0000-000000000000</DocumentFieldID>
      <Readonly>false</Readonly>
      <Required>false</Required>
      <Visible>false</Visible>
    </RegistrationProfileFieldStateBase>
  </ControlStates>
  <DependentFieldsControlStates>
    <RegistrationProfileFieldStateBase>
      <DocumentFieldID>00000000-0000-0000-0000-000000000000</DocumentFieldID>
      <Readonly>false</Readonly>
      <Required>false</Required>
      <Visible>false</Visible>
    </RegistrationProfileFieldStateBase>
  </DependentFieldsControlStates>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces">
    <d2p1:InformationMessageBase i:nil="true" />
  </Messages>
  <ReadOnly>false</ReadOnly>
</RegistrationProfileFieldStates>