DigiOffice API Services Services

ImportData

Import entity data into DigiOffice (v1)

The following routes are available for this service:
PUT	/api/importdata

"use strict";
export class ImportResult {
    /** @param {{TotalRows?:number,TotalAdded?:number,TotalUpdated?:number,SuccesfullRows?:number,ErrorRows?:number,Errors?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalRows;
    /** @type {number} */
    TotalAdded;
    /** @type {number} */
    TotalUpdated;
    /** @type {number} */
    SuccesfullRows;
    /** @type {number} */
    ErrorRows;
    /** @type {string[]} */
    Errors;
}
export class ImportField {
    /** @param {{Name?:string,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Value;
}
export class Row {
    /** @param {{Fields?:ImportField[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ImportField[]} */
    Fields;
}
export class FixedValue {
    /** @param {{Name?:string,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Value;
}
export class ImportData {
    /** @param {{EntityType?:string,ErrorField?:string,ContinueOnError?:boolean,Rows?:Row[],FixedValues?:FixedValue[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Entityname in which the data will be imported */
    EntityType;
    /**
     * @type {string}
     * @description Reports errors with a reference to this field (for example ID) */
    ErrorField;
    /**
     * @type {boolean}
     * @description Should import continue on errors? (Default true) */
    ContinueOnError;
    /**
     * @type {Row[]}
     * @description Rows to be imported */
    Rows = [];
    /**
     * @type {FixedValue[]}
     * @description Additional values to be imported on every row */
    FixedValues;
}

JavaScript ImportData 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.

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

<ImportData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.General">
  <ContinueOnError>false</ContinueOnError>
  <EntityType>String</EntityType>
  <ErrorField>String</ErrorField>
  <FixedValues>
    <ImportData.FixedValue>
      <Name>String</Name>
      <Value>String</Value>
    </ImportData.FixedValue>
  </FixedValues>
  <Rows>
    <ImportData.Row>
      <Fields>
        <ImportData.ImportField>
          <Name>String</Name>
          <Value>String</Value>
        </ImportData.ImportField>
      </Fields>
    </ImportData.Row>
  </Rows>
</ImportData>

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

<ImportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.General">
  <ErrorRows>0</ErrorRows>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Errors>
  <SuccesfullRows>0</SuccesfullRows>
  <TotalAdded>0</TotalAdded>
  <TotalRows>0</TotalRows>
  <TotalUpdated>0</TotalUpdated>
</ImportResult>