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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetRegistrationprofileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile.Operations">
  <CurrentRegistrationprofileFieldValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldValue>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationProfileFieldValue>
  </CurrentRegistrationprofileFieldValues>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <IsOffice365Context>false</IsOffice365Context>
  <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
  <PidTag>String</PidTag>
  <QueueDocumentID>0</QueueDocumentID>
  <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
  <RequestTriggeredByDependentDocumentFieldIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RequestTriggeredByDependentDocumentFieldIds>
  <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
</GetRegistrationprofileFieldStates>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
  <ControlStates>
    <RegistrationProfileFieldStateBase>
      <Readonly xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Readonly>
      <Required xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Required>
      <Visible xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Visible>
      <DocumentFieldID>00000000-0000-0000-0000-000000000000</DocumentFieldID>
    </RegistrationProfileFieldStateBase>
  </ControlStates>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces">
    <d2p1:InformationMessageBase i:nil="true" />
  </Messages>
  <ReadOnly>false</ReadOnly>
</RegistrationProfileFieldStates>