DigiOffice Gateway Web Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

export class RegisteredDocumentUpload
{
    public DocumentUploadID?: number;
    public IsSuccess?: boolean;
    public Message?: string;

    public constructor(init?: Partial<RegisteredDocumentUpload>) { (Object as any).assign(this, init); }
}

export class AddDocumentsForBackgroundRegistrationResponse
{
    public RegisteredDocumentUploads?: RegisteredDocumentUpload[];

    public constructor(init?: Partial<AddDocumentsForBackgroundRegistrationResponse>) { (Object as any).assign(this, init); }
}

export class RegistrationValue
{
    public Key?: string;
    public Value?: string;
    public ShadowValue?: string;

    public constructor(init?: Partial<RegistrationValue>) { (Object as any).assign(this, init); }
}

export class Transition
{
    public ID?: string;
    public Reason?: string;
    public DelayDate?: string;
    public DelayReason?: string;
    public UserIDs?: number[];
    public GroupIDs?: number[];

    public constructor(init?: Partial<Transition>) { (Object as any).assign(this, init); }
}

export class Process
{
    public ID?: number;
    public Title?: string;
    public Description?: string;
    public Note?: string;
    public Coordinator?: string;
    public Urgent?: boolean;
    public Transitions?: Transition[];

    public constructor(init?: Partial<Process>) { (Object as any).assign(this, init); }
}

export class RegisterDocument
{
    public RegistrationProfileID?: string;
    public Values?: RegistrationValue[];
    public Processes?: Process[];
    public DocumentUploadId?: string;
    public DocumentId?: string;
    public StandardDocumentID?: string;
    public HasUnsavedChangesInDocument?: boolean;
    public IsOpenedFromNonDMSLocation?: boolean;

    public constructor(init?: Partial<RegisterDocument>) { (Object as any).assign(this, init); }
}

/**
* Register documents queueud for registration in background
*/
// @Api(Description="Register documents queueud for registration in background")
// @ApiResponse(Description="All queued documents are linked to a systemtask for background processing", StatusCode=200)
export class AddDocumentsForBackgroundRegistration
{
    /**
    * List of queued documents to register in background
    */
    // @ApiMember(Description="List of queued documents to register in background", IsRequired=true)
    public Documents: RegisterDocument[];

    public constructor(init?: Partial<AddDocumentsForBackgroundRegistration>) { (Object as any).assign(this, init); }
}

TypeScript AddDocumentsForBackgroundRegistration DTOs

POST /api/documentuploads/registerdocuments HTTP/1.1 
Host: digiofficeapigateway.deltares.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>