DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion

Requires Authentication 
"use strict";
export class Registrationprofile {
    /** @param {{ID?:string,Name?:string,Hint?:string,Order?:number,RegisterAutomatically?:boolean,RegisterInBackground?:boolean,ThumbnailUrl?:string,ProgCode?:string,VersionControlType?:number,WOPlaceLogo?:number,WOPrinterBins?:string,SelectAllFiles?:boolean,ShowSaveDialog?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Hint;
    /** @type {number} */
    Order;
    /** @type {boolean} */
    RegisterAutomatically;
    /** @type {boolean} */
    RegisterInBackground;
    /** @type {string} */
    ThumbnailUrl;
    /** @type {string} */
    ProgCode;
    /** @type {number} */
    VersionControlType;
    /** @type {number} */
    WOPlaceLogo;
    /** @type {string} */
    WOPrinterBins;
    /** @type {boolean} */
    SelectAllFiles;
    /** @type {boolean} */
    ShowSaveDialog;
}
/** @typedef {'OneColumn_12'|'TwoColumn_6_6'|'TwoColumn_7_5'|'ThreeColumn_4_4_4'} */
export var RegistrationprofileStepLayout;
(function (RegistrationprofileStepLayout) {
    RegistrationprofileStepLayout["OneColumn_12"] = "OneColumn_12"
    RegistrationprofileStepLayout["TwoColumn_6_6"] = "TwoColumn_6_6"
    RegistrationprofileStepLayout["TwoColumn_7_5"] = "TwoColumn_7_5"
    RegistrationprofileStepLayout["ThreeColumn_4_4_4"] = "ThreeColumn_4_4_4"
})(RegistrationprofileStepLayout || (RegistrationprofileStepLayout = {}));
export class FieldState {
    /** @param {{Required?:boolean,Visible?:boolean,Readonly?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Required;
    /** @type {boolean} */
    Visible;
    /** @type {boolean} */
    Readonly;
}
export class RegistrationProfileFieldStateBase extends FieldState {
    /** @param {{DocumentFieldID?:string,Required?:boolean,Visible?:boolean,Readonly?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
}
export class RegistrationprofileField {
    /** @param {{ID?:string,DocumentFieldID?:string,Label?:string,UserControlType?:string,UserControlProperties?:SerializableKeyValuePair<string,Object>[],Hint?:string,Order?:number,HasDependableFields?:boolean,EntityName?:string,State?:RegistrationProfileFieldStateBase}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    Label;
    /** @type {string} */
    UserControlType;
    /** @type {SerializableKeyValuePair<string,Object>[]} */
    UserControlProperties;
    /** @type {string} */
    Hint;
    /** @type {number} */
    Order;
    /** @type {boolean} */
    HasDependableFields;
    /** @type {string} */
    EntityName;
    /** @type {RegistrationProfileFieldStateBase} */
    State;
}
export class RegistrationprofileGroupState {
    /** @param {{Collapsed?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Collapsed;
}
export class RegistrationprofileGroup {
    /** @param {{ID?:string,Name?:string,Label?:string,Order?:number,ColumnIndex?:number,Fields?:RegistrationprofileField[],LabelLayoutType?:number,State?:RegistrationprofileGroupState}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Label;
    /** @type {number} */
    Order;
    /** @type {number} */
    ColumnIndex;
    /** @type {RegistrationprofileField[]} */
    Fields;
    /** @type {number} */
    LabelLayoutType;
    /** @type {RegistrationprofileGroupState} */
    State;
}
export class RegistrationprofileStep {
    /** @param {{ID?:string,Name?:string,Order?:number,Layout?:RegistrationprofileStepLayout,Groups?:RegistrationprofileGroup[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Name;
    /** @type {number} */
    Order;
    /** @type {RegistrationprofileStepLayout} */
    Layout;
    /** @type {RegistrationprofileGroup[]} */
    Groups;
}
/** @typedef {number} */
export var MessageType;
(function (MessageType) {
    MessageType[MessageType["Information"] = 1] = "Information"
    MessageType[MessageType["Warning"] = 2] = "Warning"
    MessageType[MessageType["Error"] = 3] = "Error"
    MessageType[MessageType["Success"] = 4] = "Success"
})(MessageType || (MessageType = {}));
export class InformationMessageBase {
    /** @param {{Type?:MessageType,Summary?:string,FullMessage?:string,FieldName?:string,KeepOpen?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {MessageType} */
    Type;
    /** @type {string} */
    Summary;
    /** @type {string} */
    FullMessage;
    /** @type {string} */
    FieldName;
    /** @type {boolean} */
    KeepOpen;
}
export class RegistrationprofileDetails extends Registrationprofile {
    /** @param {{Steps?:RegistrationprofileStep[],Messages?:InformationMessageBase[],ReadOnly?:boolean,ID?:string,Name?:string,Hint?:string,Order?:number,RegisterAutomatically?:boolean,RegisterInBackground?:boolean,ThumbnailUrl?:string,ProgCode?:string,VersionControlType?:number,WOPlaceLogo?:number,WOPrinterBins?:string,SelectAllFiles?:boolean,ShowSaveDialog?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {RegistrationprofileStep[]} */
    Steps;
    /** @type {InformationMessageBase[]} */
    Messages;
    /** @type {boolean} */
    ReadOnly;
}
export class GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion {
    /** @param {{DocumentID?:string,QueueDocumentId?:number,IsOffice365Context?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentID;
    /** @type {number} */
    QueueDocumentId;
    /** @type {boolean} */
    IsOffice365Context;
}

JavaScript GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/GetRegistrationprofileDetailsWithQueuedDocumentAsNewVersion HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","QueueDocumentId":0,"IsOffice365Context":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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,"ShowSaveDialog":false}