DigiOffice Gateway Web Services

<back to all web services

GetMultiRegistrationProfileFieldStates

Requires Authentication 
"use strict";
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;
}
export class GetMultiRegistrationProfileFieldStates {
    /** @param {{MultiRegistrationProfileFieldStates?:GetRegistrationprofileFieldStates[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GetRegistrationprofileFieldStates[]} */
    MultiRegistrationProfileFieldStates;
}

JavaScript GetMultiRegistrationProfileFieldStates 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/GetMultiRegistrationProfileFieldStates HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetMultiRegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile.Operations">
  <MultiRegistrationProfileFieldStates>
    <GetRegistrationprofileFieldStates>
      <CurrentRegistrationprofileFieldValues xmlns:d4p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
        <d4p1:RegistrationProfileFieldValue>
          <d4p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d4p1:DocumentFieldID>
          <d4p1:IsModifiedByUser>false</d4p1:IsModifiedByUser>
          <d4p1:ShadowValue>String</d4p1:ShadowValue>
          <d4p1:Value>String</d4p1:Value>
        </d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </RequestTriggeredByDependentDocumentFieldIds>
      <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
    </GetRegistrationprofileFieldStates>
  </MultiRegistrationProfileFieldStates>
</GetMultiRegistrationProfileFieldStates>

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

<ArrayOfMultiRegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
  <MultiRegistrationProfileFieldStates>
    <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:d3p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces">
      <d3p1:InformationMessageBase i:nil="true" />
    </Messages>
    <ReadOnly>false</ReadOnly>
    <DocumentUploadID>0</DocumentUploadID>
  </MultiRegistrationProfileFieldStates>
</ArrayOfMultiRegistrationProfileFieldStates>