DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

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

namespace IDB.API.DTO.Registrationprofile
{
    public partial class RegistrationProfileFieldStateBase
    {
        public virtual Guid DocumentFieldID { get; set; }
        public virtual bool Required { get; set; }
        public virtual bool Visible { get; set; }
        public virtual bool Readonly { get; set; }
    }

    public partial class RegistrationProfileFieldStates
    {
        public RegistrationProfileFieldStates()
        {
            ControlStates = new List<RegistrationProfileFieldStateBase>{};
            DependentFieldsControlStates = new List<RegistrationProfileFieldStateBase>{};
        }

        public virtual bool ReadOnly { get; set; }
        public virtual InformationMessages Messages { get; set; }
        public virtual List<RegistrationProfileFieldStateBase> ControlStates { get; set; }
        public virtual List<RegistrationProfileFieldStateBase> DependentFieldsControlStates { get; set; }
    }

    public partial class RegistrationProfileFieldValue
    {
        public virtual Guid DocumentFieldID { get; set; }
        public virtual string Value { get; set; }
        public virtual string ShadowValue { get; set; }
        public virtual bool IsModifiedByUser { get; set; }
    }

}

namespace IDB.API.DTO.Registrationprofile.Operations
{
    public partial class GetRegistrationprofileFieldStates
    {
        public GetRegistrationprofileFieldStates()
        {
            RequestTriggeredByDependentDocumentFieldIds = new List<Guid>{};
            CurrentRegistrationprofileFieldValues = new List<RegistrationProfileFieldValue>{};
        }

        public virtual Guid RegistrationprofileID { get; set; }
        public virtual Guid? DocumentID { get; set; }
        public virtual int? QueueDocumentID { get; set; }
        public virtual Guid? StandardDocumentID { get; set; }
        public virtual List<Guid> RequestTriggeredByDependentDocumentFieldIds { get; set; }
        public virtual List<RegistrationProfileFieldValue> CurrentRegistrationprofileFieldValues { get; set; }
        public virtual bool IsOffice365Context { get; set; }
        public virtual bool? IsOpenedFromNonDMSLocation { get; set; }
        public virtual string PidTag { get; set; }
    }

}

namespace IDB.Core.Diagnostics
{
    public enum MessageType
    {
        Information = 1,
        Warning = 2,
        Error = 3,
        Success = 4,
    }

}

namespace IDB.Core.Diagnostics.Interfaces
{
    public partial class InformationMessageBase
        : IInformationMessage
    {
        public virtual MessageType Type { get; set; }
        public virtual string Summary { get; set; }
        public virtual string FullMessage { get; set; }
        public virtual string FieldName { get; set; }
        public virtual bool KeepOpen { get; set; }
    }

}

namespace IDB.Diagnostics
{
    public partial class InformationMessages
        : List<InformationMessageBase>, IInformationMessages
    {
    }

}

C# 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>