DigiOffice Gateway Web Services

GetRegistrationprofileDetailsWithDocument


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 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 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 RegistrationprofileGroupState
{
    public Collapsed: boolean;

    public constructor(init?: Partial<RegistrationprofileGroupState>) { (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 State: RegistrationprofileGroupState;

    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 GetRegistrationprofileDetailsWithDocument
{
    public ID?: string;
    public DocumentId?: string;
    public IsOffice365Context: boolean;
    public IsOpenedFromNonDMSLocation?: boolean;

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

TypeScript GetRegistrationprofileDetailsWithDocument 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/GetRegistrationprofileDetailsWithDocument HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/json
Content-Type: application/json
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: application/json
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,"State":{"Collapsed":false}}]}],"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}