DigiOffice Gateway Web Services

<back to all web services

GetRegistrationProfileDetailsFromEmailDraft

Requires Authentication

export class Registrationprofile
{
    public ID?: string;
    public Name?: string;
    public Hint?: string;
    public Order?: number;
    public RegisterAutomatically?: boolean;
    public RegisterInBackground?: boolean;
    public ThumbnailUrl?: string;
    public ProgCode?: string;
    public VersionControlType?: number;
    public WOPlaceLogo?: number;
    public WOPrinterBins?: string;
    public SelectAllFiles?: boolean;

    public constructor(init?: Partial<Registrationprofile>) { (Object as any).assign(this, init); }
}

export enum RegistrationprofileStepLayout
{
    OneColumn_12 = 'OneColumn_12',
    TwoColumn_6_6 = 'TwoColumn_6_6',
    TwoColumn_7_5 = 'TwoColumn_7_5',
    ThreeColumn_4_4_4 = 'ThreeColumn_4_4_4',
}

export class RegistrationProfileFieldStateBase
{
    public DocumentFieldID?: string;
    public Required?: boolean;
    public Visible?: boolean;
    public Readonly?: boolean;

    public constructor(init?: Partial<RegistrationProfileFieldStateBase>) { (Object as any).assign(this, init); }
}

export class RegistrationprofileField
{
    public ID?: string;
    public DocumentFieldID?: string;
    public Label?: string;
    public UserControlType?: string;
    public UserControlProperties?: SerializableKeyValuePair<string,Object>[];
    public Hint?: string;
    public Order?: number;
    public HasDependableFields?: boolean;
    public EntityName?: string;
    public State?: RegistrationProfileFieldStateBase;

    public constructor(init?: Partial<RegistrationprofileField>) { (Object as any).assign(this, init); }
}

export class RegistrationprofileGroup
{
    public ID?: string;
    public Name?: string;
    public Label?: string;
    public Order?: number;
    public ColumnIndex?: number;
    public Fields?: RegistrationprofileField[];
    public LabelLayoutType?: number;

    public constructor(init?: Partial<RegistrationprofileGroup>) { (Object as any).assign(this, init); }
}

export class RegistrationprofileStep
{
    public ID?: string;
    public Name?: string;
    public Order?: number;
    public Layout?: RegistrationprofileStepLayout;
    public Groups?: RegistrationprofileGroup[];

    public constructor(init?: Partial<RegistrationprofileStep>) { (Object as any).assign(this, init); }
}

export enum MessageType
{
    Information = 1,
    Warning = 2,
    Error = 3,
    Success = 4,
}

export class InformationMessageBase implements IInformationMessage
{
    public Type?: MessageType;
    public Summary?: string;
    public FullMessage?: string;
    public FieldName?: string;
    public KeepOpen?: boolean;

    public constructor(init?: Partial<InformationMessageBase>) { (Object as any).assign(this, init); }
}

export class RegistrationprofileDetails extends Registrationprofile
{
    public Steps?: RegistrationprofileStep[];
    public Messages?: InformationMessageBase[];
    public ReadOnly?: boolean;

    public constructor(init?: Partial<RegistrationprofileDetails>) { super(init); (Object as any).assign(this, init); }
}

export class GetRegistrationProfileDetailsFromEmailDraft
{
    public PidTag?: string;
    public IsOffice365Context?: boolean;

    public constructor(init?: Partial<GetRegistrationProfileDetailsFromEmailDraft>) { (Object as any).assign(this, init); }
}

TypeScript GetRegistrationProfileDetailsFromEmailDraft 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/GetRegistrationProfileDetailsFromEmailDraft HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PidTag: String,
	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
}