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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"RegistrationprofileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","QueueDocumentID":0,"StandardDocumentID":"00000000-0000-0000-0000-000000000000","RequestTriggeredByDependentDocumentFieldIds":["00000000-0000-0000-0000-000000000000"],"CurrentRegistrationprofileFieldValues":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IsOffice365Context":false,"IsOpenedFromNonDMSLocation":false,"PidTag":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"DependentFieldsControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}