DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithDocument

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.Core.Diagnostics.Interfaces;
using IDB.Core.Diagnostics;

namespace IDB.API.DTO.Registrationprofile
{
    public partial class Registrationprofile
    {
        public virtual Guid ID { get; set; }
        public virtual string Name { get; set; }
        public virtual string Hint { get; set; }
        public virtual int Order { get; set; }
        public virtual bool RegisterAutomatically { get; set; }
        public virtual bool RegisterInBackground { get; set; }
        public virtual string ThumbnailUrl { get; set; }
        public virtual string ProgCode { get; set; }
        public virtual int VersionControlType { get; set; }
        public virtual int WOPlaceLogo { get; set; }
        public virtual string WOPrinterBins { get; set; }
        public virtual bool SelectAllFiles { get; set; }
    }

    public partial class RegistrationprofileDetails
        : Registrationprofile
    {
        public RegistrationprofileDetails()
        {
            Steps = new List<RegistrationprofileStep>{};
            Messages = new List<InformationMessageBase>{};
        }

        public virtual List<RegistrationprofileStep> Steps { get; set; }
        public virtual List<InformationMessageBase> Messages { get; set; }
        public virtual bool ReadOnly { get; set; }
    }

    public partial class RegistrationprofileField
    {
        public RegistrationprofileField()
        {
            UserControlProperties = new List<SerializableKeyValuePair<String,Object>>{};
        }

        public virtual Guid ID { get; set; }
        public virtual Guid DocumentFieldID { get; set; }
        public virtual string Label { get; set; }
        public virtual string UserControlType { get; set; }
        public virtual List<SerializableKeyValuePair<String,Object>> UserControlProperties { get; set; }
        public virtual string Hint { get; set; }
        public virtual int Order { get; set; }
        public virtual bool HasDependableFields { get; set; }
        public virtual string EntityName { get; set; }
        public virtual RegistrationProfileFieldStateBase State { get; set; }
    }

    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 RegistrationprofileGroup
    {
        public RegistrationprofileGroup()
        {
            Fields = new List<RegistrationprofileField>{};
        }

        public virtual Guid ID { get; set; }
        public virtual string Name { get; set; }
        public virtual string Label { get; set; }
        public virtual int Order { get; set; }
        public virtual int ColumnIndex { get; set; }
        public virtual List<RegistrationprofileField> Fields { get; set; }
        public virtual int LabelLayoutType { get; set; }
    }

    public partial class RegistrationprofileStep
    {
        public RegistrationprofileStep()
        {
            Groups = new List<RegistrationprofileGroup>{};
        }

        public virtual Guid ID { get; set; }
        public virtual string Name { get; set; }
        public virtual int Order { get; set; }
        public virtual RegistrationprofileStep.RegistrationprofileStepLayout Layout { get; set; }
        public virtual List<RegistrationprofileGroup> Groups { get; set; }
        public enum RegistrationprofileStepLayout
        {
            OneColumn_12,
            TwoColumn_6_6,
            TwoColumn_7_5,
            ThreeColumn_4_4_4,
        }

    }

}

namespace IDB.API.DTO.Registrationprofile.Operations
{
    public partial class GetRegistrationprofileDetailsWithDocument
    {
        public virtual Guid? ID { get; set; }
        public virtual Guid? DocumentId { get; set; }
        public virtual bool IsOffice365Context { get; set; }
        public virtual bool? IsOpenedFromNonDMSLocation { 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; }
    }

}

C# GetRegistrationprofileDetailsWithDocument DTOs

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

HTTP + CSV

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

POST /csv/reply/GetRegistrationprofileDetailsWithDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","DocumentId":"00000000-0000-0000-0000-000000000000","IsOffice365Context":false,"IsOpenedFromNonDMSLocation":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Steps":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Order":0,"Layout":"OneColumn_12","Groups":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Order":0,"ColumnIndex":0,"Fields":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Label":"String","UserControlType":"String","UserControlProperties":[{}],"Hint":"String","Order":0,"HasDependableFields":false,"EntityName":"String","State":{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}}],"LabelLayoutType":0}]}],"Messages":[{}],"ReadOnly":false,"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Hint":"String","Order":0,"RegisterAutomatically":false,"RegisterInBackground":false,"ThumbnailUrl":"String","ProgCode":"String","VersionControlType":0,"WOPlaceLogo":0,"WOPrinterBins":"String","SelectAllFiles":false}