DigiOffice API Services Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

"use strict";
export class RegisteredDocumentUpload {
    /** @param {{DocumentUploadID?:number,IsSuccess?:boolean,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentUploadID;
    /** @type {boolean} */
    IsSuccess;
    /** @type {string} */
    Message;
}
export class AddDocumentsForBackgroundRegistrationResponse {
    /** @param {{RegisteredDocumentUploads?:RegisteredDocumentUpload[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RegisteredDocumentUpload[]} */
    RegisteredDocumentUploads;
}
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;
}
export class AddDocumentsForBackgroundRegistration {
    /** @param {{Documents?:RegisterDocument[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {RegisterDocument[]}
     * @description List of queued documents to register in background */
    Documents = [];
}

JavaScript AddDocumentsForBackgroundRegistration DTOs

POST /api/documentuploads/registerdocuments HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<AddDocumentsForBackgroundRegistrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <RegisteredDocumentUploads>
    <RegisteredDocumentUpload>
      <DocumentUploadID>0</DocumentUploadID>
      <IsSuccess>false</IsSuccess>
      <Message>String</Message>
    </RegisteredDocumentUpload>
  </RegisteredDocumentUploads>
</AddDocumentsForBackgroundRegistrationResponse>