DigiOffice Gateway Web Services

<back to all web services

RegisterDocument

"use strict";
export class RegisterDocumentResponse {
    /** @param {{IsSucces?:boolean,DocumentId?:string,ErrorMessages?:string[],Ooxml?:string,IsCorporateIdentity?:boolean,DocumentVariables?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    IsSucces;
    /** @type {string} */
    DocumentId;
    /** @type {string[]} */
    ErrorMessages;
    /** @type {string} */
    Ooxml;
    /**
     * @type {boolean}
     * @description Is it a corporate identity document? */
    IsCorporateIdentity;
    /** @type {{ [index:string]: string; }} */
    DocumentVariables;
}
export class RegistrationValue {
    /** @param {{Key?:string,Value?:string,ShadowValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
}
export class Transition {
    /** @param {{ID?:string,Reason?:string,DelayDate?:string,DelayReason?:string,UserIDs?:number[],GroupIDs?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Reason;
    /** @type {?string} */
    DelayDate;
    /** @type {string} */
    DelayReason;
    /** @type {number[]} */
    UserIDs;
    /** @type {number[]} */
    GroupIDs;
}
export class Process {
    /** @param {{ID?:number,Title?:string,Description?:string,Note?:string,Coordinator?:string,Urgent?:boolean,Transitions?:Transition[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Title;
    /** @type {string} */
    Description;
    /** @type {string} */
    Note;
    /** @type {string} */
    Coordinator;
    /** @type {boolean} */
    Urgent;
    /** @type {Transition[]} */
    Transitions;
}
export class RegisterDocument {
    /** @param {{RegistrationProfileID?:string,Values?:RegistrationValue[],Processes?:Process[],DocumentUploadId?:string,DocumentId?:string,StandardDocumentID?:string,HasUnsavedChangesInDocument?:boolean,IsOpenedFromNonDMSLocation?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RegistrationProfileID;
    /** @type {RegistrationValue[]} */
    Values;
    /** @type {Process[]} */
    Processes;
    /** @type {string} */
    DocumentUploadId;
    /** @type {?string} */
    DocumentId;
    /** @type {?string} */
    StandardDocumentID;
    /** @type {?boolean} */
    HasUnsavedChangesInDocument;
    /** @type {?boolean} */
    IsOpenedFromNonDMSLocation;
}

JavaScript RegisterDocument DTOs

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

<RegisterDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <DocumentUploadId>String</DocumentUploadId>
  <HasUnsavedChangesInDocument>false</HasUnsavedChangesInDocument>
  <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
  <Processes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
    <d2p1:Process>
      <d2p1:Coordinator>String</d2p1:Coordinator>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Transitions>
        <d2p1:Transition>
          <d2p1:DelayDate>0001-01-01T00:00:00</d2p1:DelayDate>
          <d2p1:DelayReason>String</d2p1:DelayReason>
          <d2p1:GroupIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:GroupIDs>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:Reason>String</d2p1:Reason>
          <d2p1:UserIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:UserIDs>
        </d2p1:Transition>
      </d2p1:Transitions>
      <d2p1:Urgent>false</d2p1:Urgent>
    </d2p1:Process>
  </Processes>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationValue>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationValue>
  </Values>
</RegisterDocument>

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

<RegisterDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <DocumentVariables xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ErrorMessages>
  <IsCorporateIdentity>false</IsCorporateIdentity>
  <IsSucces>false</IsSucces>
  <Ooxml>String</Ooxml>
</RegisterDocumentResponse>