DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication

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 InformationMessages extends Array<InformationMessageBase> implements IInformationMessages
{

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

export class FieldState
{
    public Required: boolean;
    public Visible: boolean;
    public Readonly: boolean;

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

export class RegistrationProfileFieldStateBase extends FieldState
{
    public DocumentFieldID: string;

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

export class RegistrationProfileFieldStates
{
    public ReadOnly: boolean;
    public Messages: InformationMessages;
    public ControlStates: RegistrationProfileFieldStateBase[];

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

export class RegistrationProfileFieldValue
{
    public DocumentFieldID: string;
    public Value: string;
    public ShadowValue: string;
    public IsModifiedByUser: boolean;

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

export class GetRegistrationprofileFieldStates
{
    public RegistrationprofileID: string;
    public DocumentID?: string;
    public QueueDocumentID?: number;
    public StandardDocumentID?: string;
    public RequestTriggeredByDependentDocumentFieldIds: string[];
    public CurrentRegistrationprofileFieldValues: RegistrationProfileFieldValue[];
    public IsOffice365Context: boolean;
    public IsOpenedFromNonDMSLocation?: boolean;
    public PidTag: string;

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

TypeScript GetRegistrationprofileFieldStates 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/GetRegistrationprofileFieldStates HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocumentID: 00000000-0000-0000-0000-000000000000,
	QueueDocumentID: 0,
	StandardDocumentID: 00000000-0000-0000-0000-000000000000,
	RequestTriggeredByDependentDocumentFieldIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	CurrentRegistrationprofileFieldValues: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	],
	IsOffice365Context: False,
	IsOpenedFromNonDMSLocation: False,
	PidTag: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReadOnly: False,
	Messages: 
	[
		{
			
		}
	],
	ControlStates: 
	[
		{
			Required: False,
			Visible: False,
			Readonly: False
		}
	]
}