DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithStandardDocument

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

public class dtos
{

    public static class GetRegistrationprofileDetailsWithStandardDocument
    {
        public UUID StandardDocumentID = null;
        public Boolean IsOffice365Context = null;
        
        public UUID getStandardDocumentID() { return StandardDocumentID; }
        public GetRegistrationprofileDetailsWithStandardDocument setStandardDocumentID(UUID value) { this.StandardDocumentID = value; return this; }
        public Boolean getIsOffice365Context() { return IsOffice365Context; }
        public GetRegistrationprofileDetailsWithStandardDocument setIsOffice365Context(Boolean value) { this.IsOffice365Context = value; return this; }
    }

    public static class RegistrationprofileDetails extends Registrationprofile
    {
        public ArrayList<RegistrationprofileStep> Steps = null;
        public ArrayList<InformationMessageBase> Messages = null;
        public Boolean ReadOnly = null;
        
        public ArrayList<RegistrationprofileStep> getSteps() { return Steps; }
        public RegistrationprofileDetails setSteps(ArrayList<RegistrationprofileStep> value) { this.Steps = value; return this; }
        public ArrayList<InformationMessageBase> getMessages() { return Messages; }
        public RegistrationprofileDetails setMessages(ArrayList<InformationMessageBase> value) { this.Messages = value; return this; }
        public Boolean isReadOnly() { return ReadOnly; }
        public RegistrationprofileDetails setReadOnly(Boolean value) { this.ReadOnly = value; return this; }
    }

    public static class Registrationprofile
    {
        public UUID ID = null;
        public String Name = null;
        public String Hint = null;
        public Integer Order = null;
        public Boolean RegisterAutomatically = null;
        public Boolean RegisterInBackground = null;
        public String ThumbnailUrl = null;
        public String ProgCode = null;
        public Integer VersionControlType = null;
        public Integer WOPlaceLogo = null;
        public String WOPrinterBins = null;
        public Boolean SelectAllFiles = null;
        
        public UUID getId() { return ID; }
        public Registrationprofile setId(UUID value) { this.ID = value; return this; }
        public String getName() { return Name; }
        public Registrationprofile setName(String value) { this.Name = value; return this; }
        public String getHint() { return Hint; }
        public Registrationprofile setHint(String value) { this.Hint = value; return this; }
        public Integer getOrder() { return Order; }
        public Registrationprofile setOrder(Integer value) { this.Order = value; return this; }
        public Boolean isRegisterAutomatically() { return RegisterAutomatically; }
        public Registrationprofile setRegisterAutomatically(Boolean value) { this.RegisterAutomatically = value; return this; }
        public Boolean isRegisterInBackground() { return RegisterInBackground; }
        public Registrationprofile setRegisterInBackground(Boolean value) { this.RegisterInBackground = value; return this; }
        public String getThumbnailUrl() { return ThumbnailUrl; }
        public Registrationprofile setThumbnailUrl(String value) { this.ThumbnailUrl = value; return this; }
        public String getProgCode() { return ProgCode; }
        public Registrationprofile setProgCode(String value) { this.ProgCode = value; return this; }
        public Integer getVersionControlType() { return VersionControlType; }
        public Registrationprofile setVersionControlType(Integer value) { this.VersionControlType = value; return this; }
        public Integer getWoPlaceLogo() { return WOPlaceLogo; }
        public Registrationprofile setWoPlaceLogo(Integer value) { this.WOPlaceLogo = value; return this; }
        public String getWoPrinterBins() { return WOPrinterBins; }
        public Registrationprofile setWoPrinterBins(String value) { this.WOPrinterBins = value; return this; }
        public Boolean isSelectAllFiles() { return SelectAllFiles; }
        public Registrationprofile setSelectAllFiles(Boolean value) { this.SelectAllFiles = value; return this; }
    }

    public static class RegistrationprofileStep
    {
        public UUID ID = null;
        public String Name = null;
        public Integer Order = null;
        public RegistrationprofileStepLayout Layout = null;
        public ArrayList<RegistrationprofileGroup> Groups = null;
        
        public UUID getId() { return ID; }
        public RegistrationprofileStep setId(UUID value) { this.ID = value; return this; }
        public String getName() { return Name; }
        public RegistrationprofileStep setName(String value) { this.Name = value; return this; }
        public Integer getOrder() { return Order; }
        public RegistrationprofileStep setOrder(Integer value) { this.Order = value; return this; }
        public RegistrationprofileStepLayout getLayout() { return Layout; }
        public RegistrationprofileStep setLayout(RegistrationprofileStepLayout value) { this.Layout = value; return this; }
        public ArrayList<RegistrationprofileGroup> getGroups() { return Groups; }
        public RegistrationprofileStep setGroups(ArrayList<RegistrationprofileGroup> value) { this.Groups = value; return this; }
    }

    public static enum RegistrationprofileStepLayout
    {
        OneColumn12,
        TwoColumn66,
        TwoColumn75,
        ThreeColumn444;
    }

    public static class RegistrationprofileGroup
    {
        public UUID ID = null;
        public String Name = null;
        public String Label = null;
        public Integer Order = null;
        public Integer ColumnIndex = null;
        public ArrayList<RegistrationprofileField> Fields = null;
        public Integer LabelLayoutType = null;
        
        public UUID getId() { return ID; }
        public RegistrationprofileGroup setId(UUID value) { this.ID = value; return this; }
        public String getName() { return Name; }
        public RegistrationprofileGroup setName(String value) { this.Name = value; return this; }
        public String getLabel() { return Label; }
        public RegistrationprofileGroup setLabel(String value) { this.Label = value; return this; }
        public Integer getOrder() { return Order; }
        public RegistrationprofileGroup setOrder(Integer value) { this.Order = value; return this; }
        public Integer getColumnIndex() { return ColumnIndex; }
        public RegistrationprofileGroup setColumnIndex(Integer value) { this.ColumnIndex = value; return this; }
        public ArrayList<RegistrationprofileField> getFields() { return Fields; }
        public RegistrationprofileGroup setFields(ArrayList<RegistrationprofileField> value) { this.Fields = value; return this; }
        public Integer getLabelLayoutType() { return LabelLayoutType; }
        public RegistrationprofileGroup setLabelLayoutType(Integer value) { this.LabelLayoutType = value; return this; }
    }

    public static class RegistrationprofileField
    {
        public UUID ID = null;
        public UUID DocumentFieldID = null;
        public String Label = null;
        public String UserControlType = null;
        public ArrayList<SerializableKeyValuePair<String,Object>> UserControlProperties = null;
        public String Hint = null;
        public Integer Order = null;
        public Boolean HasDependableFields = null;
        public String EntityName = null;
        public RegistrationProfileFieldStateBase State = null;
        
        public UUID getId() { return ID; }
        public RegistrationprofileField setId(UUID value) { this.ID = value; return this; }
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public RegistrationprofileField setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
        public String getLabel() { return Label; }
        public RegistrationprofileField setLabel(String value) { this.Label = value; return this; }
        public String getUserControlType() { return UserControlType; }
        public RegistrationprofileField setUserControlType(String value) { this.UserControlType = value; return this; }
        public ArrayList<SerializableKeyValuePair<String,Object>> getUserControlProperties() { return UserControlProperties; }
        public RegistrationprofileField setUserControlProperties(ArrayList<SerializableKeyValuePair<String,Object>> value) { this.UserControlProperties = value; return this; }
        public String getHint() { return Hint; }
        public RegistrationprofileField setHint(String value) { this.Hint = value; return this; }
        public Integer getOrder() { return Order; }
        public RegistrationprofileField setOrder(Integer value) { this.Order = value; return this; }
        public Boolean isHasDependableFields() { return HasDependableFields; }
        public RegistrationprofileField setHasDependableFields(Boolean value) { this.HasDependableFields = value; return this; }
        public String getEntityName() { return EntityName; }
        public RegistrationprofileField setEntityName(String value) { this.EntityName = value; return this; }
        public RegistrationProfileFieldStateBase getState() { return State; }
        public RegistrationprofileField setState(RegistrationProfileFieldStateBase value) { this.State = value; return this; }
    }

    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; }
    }

    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; }
    }

}

Java GetRegistrationprofileDetailsWithStandardDocument DTOs

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

HTTP + JSV

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

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

{
	IsOffice365Context: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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