DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
"use strict";
/** @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 InformationMessages extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
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 RegistrationProfileFieldStates {
    /** @param {{ReadOnly?:boolean,Messages?:InformationMessages,ControlStates?:RegistrationProfileFieldStateBase[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    ReadOnly;
    /** @type {InformationMessages} */
    Messages;
    /** @type {RegistrationProfileFieldStateBase[]} */
    ControlStates;
}
export class RegistrationProfileFieldValue {
    /** @param {{DocumentFieldID?:string,Value?:string,ShadowValue?:string,IsModifiedByUser?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
    /** @type {boolean} */
    IsModifiedByUser;
}
export class GetRegistrationprofileFieldStates {
    /** @param {{RegistrationprofileID?:string,DocumentID?:string,QueueDocumentID?:number,StandardDocumentID?:string,RequestTriggeredByDependentDocumentFieldIds?:string[],CurrentRegistrationprofileFieldValues?:RegistrationProfileFieldValue[],IsOffice365Context?:boolean,IsOpenedFromNonDMSLocation?:boolean,PidTag?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RegistrationprofileID;
    /** @type {?string} */
    DocumentID;
    /** @type {?number} */
    QueueDocumentID;
    /** @type {?string} */
    StandardDocumentID;
    /** @type {string[]} */
    RequestTriggeredByDependentDocumentFieldIds;
    /** @type {RegistrationProfileFieldValue[]} */
    CurrentRegistrationprofileFieldValues;
    /** @type {boolean} */
    IsOffice365Context;
    /** @type {?boolean} */
    IsOpenedFromNonDMSLocation;
    /** @type {string} */
    PidTag;
}

JavaScript GetRegistrationprofileFieldStates 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/GetRegistrationprofileFieldStates HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}