DigiOffice API Services Services

<back to all web services

GetQuickRegistrationOptions

Requires Authentication 
"use strict";
export class RegistrationprofileInformation {
    /** @param {{ID?:string,Name?:string,WizardAutomatischDoorlopen?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    ID;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    WizardAutomatischDoorlopen;
}
/** @typedef {'CopyEmailIncludingAttachments'|'CopyEmailIncludingAndSeparateAttachments'|'CopyEmailExcludingAndSeparateAttachments'|'CopyEmailExcludingAttachments'|'CopyOnlyAttachments'|'MoveEmailIncludingAttachments'|'MoveEmailIncludingAndSeparateAttachments'|'MoveEmailExcludingAndSeparateAttachments'|'MoveEmailExcludingAttachments'|'MoveOnlyAttachments'|'Files'|'FileStream'} */
export var DragDropAction;
(function (DragDropAction) {
    DragDropAction["CopyEmailIncludingAttachments"] = "CopyEmailIncludingAttachments"
    DragDropAction["CopyEmailIncludingAndSeparateAttachments"] = "CopyEmailIncludingAndSeparateAttachments"
    DragDropAction["CopyEmailExcludingAndSeparateAttachments"] = "CopyEmailExcludingAndSeparateAttachments"
    DragDropAction["CopyEmailExcludingAttachments"] = "CopyEmailExcludingAttachments"
    DragDropAction["CopyOnlyAttachments"] = "CopyOnlyAttachments"
    DragDropAction["MoveEmailIncludingAttachments"] = "MoveEmailIncludingAttachments"
    DragDropAction["MoveEmailIncludingAndSeparateAttachments"] = "MoveEmailIncludingAndSeparateAttachments"
    DragDropAction["MoveEmailExcludingAndSeparateAttachments"] = "MoveEmailExcludingAndSeparateAttachments"
    DragDropAction["MoveEmailExcludingAttachments"] = "MoveEmailExcludingAttachments"
    DragDropAction["MoveOnlyAttachments"] = "MoveOnlyAttachments"
    DragDropAction["Files"] = "Files"
    DragDropAction["FileStream"] = "FileStream"
})(DragDropAction || (DragDropAction = {}));
export class QuickRegistrationOptions {
    /** @param {{ProgCode?:string,RegistrationProfileID?:string,RegistrationProfiles?:RegistrationprofileInformation[],AttachmentRegistrationProfileID?:string,AttachmentProfiles?:RegistrationprofileInformation[],RegistrationProfileNewEmailID?:string,EMailActie?:string,EMailActieNieuw?:string,EMailActieBeantwoorden?:string,EMailActieDoorsturen?:string,DefaultDragDropAction?:DragDropAction,RegistratieWizard365URL?:string,ApplicationName?:string,Extension?:string,MenuTonenBijSlepen?:boolean,AllowMultipleRegistrations?:boolean,MinimumAttachmentSize?:number,AllowEmptyEmailInRegistrationprofileWizard?:boolean,UpdateRefNrInSentItems?:boolean,VersturenViaBCC?:boolean,BCCEmailAdres?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProgCode;
    /** @type {?string} */
    RegistrationProfileID;
    /** @type {RegistrationprofileInformation[]} */
    RegistrationProfiles;
    /** @type {?string} */
    AttachmentRegistrationProfileID;
    /** @type {RegistrationprofileInformation[]} */
    AttachmentProfiles;
    /** @type {?string} */
    RegistrationProfileNewEmailID;
    /** @type {string} */
    EMailActie;
    /** @type {string} */
    EMailActieNieuw;
    /** @type {string} */
    EMailActieBeantwoorden;
    /** @type {string} */
    EMailActieDoorsturen;
    /** @type {DragDropAction} */
    DefaultDragDropAction;
    /** @type {string} */
    RegistratieWizard365URL;
    /** @type {string} */
    ApplicationName;
    /** @type {string} */
    Extension;
    /** @type {boolean} */
    MenuTonenBijSlepen;
    /** @type {boolean} */
    AllowMultipleRegistrations;
    /** @type {number} */
    MinimumAttachmentSize;
    /** @type {boolean} */
    AllowEmptyEmailInRegistrationprofileWizard;
    /** @type {boolean} */
    UpdateRefNrInSentItems;
    /** @type {boolean} */
    VersturenViaBCC;
    /** @type {string} */
    BCCEmailAdres;
}
export class GetQuickRegistrationOptions {
    /** @param {{ProgCode?:string,ApplicationName?:string,Extension?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProgCode;
    /** @type {string} */
    ApplicationName;
    /** @type {string} */
    Extension;
}

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

<GetQuickRegistrationOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <ApplicationName>String</ApplicationName>
  <Extension>String</Extension>
  <ProgCode>String</ProgCode>
</GetQuickRegistrationOptions>

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

<QuickRegistrationOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <AllowEmptyEmailInRegistrationprofileWizard>false</AllowEmptyEmailInRegistrationprofileWizard>
  <AllowMultipleRegistrations>false</AllowMultipleRegistrations>
  <ApplicationName>String</ApplicationName>
  <AttachmentProfiles xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationprofileInformation>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:WizardAutomatischDoorlopen>false</d2p1:WizardAutomatischDoorlopen>
    </d2p1:RegistrationprofileInformation>
  </AttachmentProfiles>
  <AttachmentRegistrationProfileID>00000000-0000-0000-0000-000000000000</AttachmentRegistrationProfileID>
  <BCCEmailAdres>String</BCCEmailAdres>
  <DefaultDragDropAction>CopyEmailIncludingAttachments</DefaultDragDropAction>
  <EMailActieBeantwoorden>String</EMailActieBeantwoorden>
  <EMailActieDoorsturen>String</EMailActieDoorsturen>
  <EMailActieNieuw>String</EMailActieNieuw>
  <Extension>String</Extension>
  <MenuTonenBijSlepen>false</MenuTonenBijSlepen>
  <MinimumAttachmentSize>0</MinimumAttachmentSize>
  <ProgCode>String</ProgCode>
  <RegistratieWizard365URL>String</RegistratieWizard365URL>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <RegistrationProfileNewEmailID>00000000-0000-0000-0000-000000000000</RegistrationProfileNewEmailID>
  <RegistrationProfiles xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationprofileInformation>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:WizardAutomatischDoorlopen>false</d2p1:WizardAutomatischDoorlopen>
    </d2p1:RegistrationprofileInformation>
  </RegistrationProfiles>
  <UpdateRefNrInSentItems>false</UpdateRefNrInSentItems>
  <VersturenViaBCC>false</VersturenViaBCC>
</QuickRegistrationOptions>