DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

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

public class dtos
{

    public static class GetRegistrationprofileFieldStates
    {
        public UUID RegistrationprofileID = null;
        public UUID DocumentID = null;
        public Integer QueueDocumentID = null;
        public UUID StandardDocumentID = null;
        public ArrayList<UUID> RequestTriggeredByDependentDocumentFieldIds = null;
        public ArrayList<RegistrationProfileFieldValue> CurrentRegistrationprofileFieldValues = null;
        public Boolean IsOffice365Context = null;
        public Boolean IsOpenedFromNonDMSLocation = null;
        public String PidTag = null;
        
        public UUID getRegistrationprofileID() { return RegistrationprofileID; }
        public GetRegistrationprofileFieldStates setRegistrationprofileID(UUID value) { this.RegistrationprofileID = value; return this; }
        public UUID getDocumentID() { return DocumentID; }
        public GetRegistrationprofileFieldStates setDocumentID(UUID value) { this.DocumentID = value; return this; }
        public Integer getQueueDocumentID() { return QueueDocumentID; }
        public GetRegistrationprofileFieldStates setQueueDocumentID(Integer value) { this.QueueDocumentID = value; return this; }
        public UUID getStandardDocumentID() { return StandardDocumentID; }
        public GetRegistrationprofileFieldStates setStandardDocumentID(UUID value) { this.StandardDocumentID = value; return this; }
        public ArrayList<UUID> getRequestTriggeredByDependentDocumentFieldIds() { return RequestTriggeredByDependentDocumentFieldIds; }
        public GetRegistrationprofileFieldStates setRequestTriggeredByDependentDocumentFieldIds(ArrayList<UUID> value) { this.RequestTriggeredByDependentDocumentFieldIds = value; return this; }
        public ArrayList<RegistrationProfileFieldValue> getCurrentRegistrationprofileFieldValues() { return CurrentRegistrationprofileFieldValues; }
        public GetRegistrationprofileFieldStates setCurrentRegistrationprofileFieldValues(ArrayList<RegistrationProfileFieldValue> value) { this.CurrentRegistrationprofileFieldValues = value; return this; }
        public Boolean getIsOffice365Context() { return IsOffice365Context; }
        public GetRegistrationprofileFieldStates setIsOffice365Context(Boolean value) { this.IsOffice365Context = value; return this; }
        public Boolean getIsOpenedFromNonDMSLocation() { return IsOpenedFromNonDMSLocation; }
        public GetRegistrationprofileFieldStates setIsOpenedFromNonDMSLocation(Boolean value) { this.IsOpenedFromNonDMSLocation = value; return this; }
        public String getPidTag() { return PidTag; }
        public GetRegistrationprofileFieldStates setPidTag(String value) { this.PidTag = value; return this; }
    }

    public static class RegistrationProfileFieldValue
    {
        public UUID DocumentFieldID = null;
        public String Value = null;
        public String ShadowValue = null;
        public Boolean IsModifiedByUser = null;
        
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public RegistrationProfileFieldValue setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
        public String getValue() { return Value; }
        public RegistrationProfileFieldValue setValue(String value) { this.Value = value; return this; }
        public String getShadowValue() { return ShadowValue; }
        public RegistrationProfileFieldValue setShadowValue(String value) { this.ShadowValue = value; return this; }
        public Boolean getIsModifiedByUser() { return IsModifiedByUser; }
        public RegistrationProfileFieldValue setIsModifiedByUser(Boolean value) { this.IsModifiedByUser = value; return this; }
    }

    public static class RegistrationProfileFieldStates
    {
        public Boolean ReadOnly = null;
        public InformationMessages Messages = null;
        public ArrayList<RegistrationProfileFieldStateBase> ControlStates = null;
        public ArrayList<RegistrationProfileFieldStateBase> DependentFieldsControlStates = null;
        
        public Boolean isReadOnly() { return ReadOnly; }
        public RegistrationProfileFieldStates setReadOnly(Boolean value) { this.ReadOnly = value; return this; }
        public InformationMessages getMessages() { return Messages; }
        public RegistrationProfileFieldStates setMessages(InformationMessages value) { this.Messages = value; return this; }
        public ArrayList<RegistrationProfileFieldStateBase> getControlStates() { return ControlStates; }
        public RegistrationProfileFieldStates setControlStates(ArrayList<RegistrationProfileFieldStateBase> value) { this.ControlStates = value; return this; }
        public ArrayList<RegistrationProfileFieldStateBase> getDependentFieldsControlStates() { return DependentFieldsControlStates; }
        public RegistrationProfileFieldStates setDependentFieldsControlStates(ArrayList<RegistrationProfileFieldStateBase> value) { this.DependentFieldsControlStates = value; return this; }
    }

    public static class InformationMessages extends ArrayList<InformationMessageBase> implements IInformationMessages
    {
        
    }

    public static class InformationMessageBase implements IInformationMessage
    {
        public MessageType Type = null;
        public String Summary = null;
        public String FullMessage = null;
        public String FieldName = null;
        public Boolean KeepOpen = null;
        
        public MessageType getType() { return Type; }
        public InformationMessageBase setType(MessageType value) { this.Type = value; return this; }
        public String getSummary() { return Summary; }
        public InformationMessageBase setSummary(String value) { this.Summary = value; return this; }
        public String getFullMessage() { return FullMessage; }
        public InformationMessageBase setFullMessage(String value) { this.FullMessage = value; return this; }
        public String getFieldName() { return FieldName; }
        public InformationMessageBase setFieldName(String value) { this.FieldName = value; return this; }
        public Boolean isKeepOpen() { return KeepOpen; }
        public InformationMessageBase setKeepOpen(Boolean value) { this.KeepOpen = value; return this; }
    }

    public static enum MessageType
    {
        Information(1),
        Warning(2),
        Error(3),
        Success(4);

        private final int value;
        MessageType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class RegistrationProfileFieldStateBase
    {
        public UUID DocumentFieldID = null;
        public Boolean Required = null;
        public Boolean Visible = null;
        public Boolean Readonly = null;
        
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public RegistrationProfileFieldStateBase setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
        public Boolean isRequired() { return Required; }
        public RegistrationProfileFieldStateBase setRequired(Boolean value) { this.Required = value; return this; }
        public Boolean isVisible() { return Visible; }
        public RegistrationProfileFieldStateBase setVisible(Boolean value) { this.Visible = value; return this; }
        public Boolean isReadonly() { return Readonly; }
        public RegistrationProfileFieldStateBase setReadonly(Boolean value) { this.Readonly = value; return this; }
    }

}

Java 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>