DigiOffice API Services Services

<back to all web services

ImportData

Import entity data into DigiOffice (v1)

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.General;

namespace IDB.API.General
{
    ///<summary>
    ///Import entity data into DigiOffice (v1)
    ///</summary>
    [Api(Description="Import entity data into DigiOffice (v1)")]
    public partial class ImportData
    {
        ///<summary>
        ///Entityname in which the data will be imported
        ///</summary>
        [ApiMember(Description="Entityname in which the data will be imported", IsRequired=true)]
        public virtual string EntityType { get; set; }

        ///<summary>
        ///Reports errors with a reference to this field (for example ID)
        ///</summary>
        [ApiMember(Description="Reports errors with a reference to this field (for example ID)")]
        public virtual string ErrorField { get; set; }

        ///<summary>
        ///Should import continue on errors? (Default true)
        ///</summary>
        [ApiMember(Description="Should import continue on errors? (Default true)")]
        public virtual bool ContinueOnError { get; set; }

        ///<summary>
        ///Rows to be imported
        ///</summary>
        [ApiMember(Description="Rows to be imported", IsRequired=true)]
        public virtual List<Row> Rows { get; set; } = [];

        ///<summary>
        ///Additional values to be imported on every row
        ///</summary>
        [ApiMember(Description="Additional values to be imported on every row")]
        public virtual List<FixedValue> FixedValues { get; set; }
        public partial class Row
        {
            public virtual List<ImportField> Fields { get; set; }
        }

        public partial class ImportField
        {
            public virtual string Name { get; set; }
            public virtual string Value { get; set; }
        }

        public partial class FixedValue
        {
            public virtual string Name { get; set; }
            public virtual string Value { get; set; }
        }

    }

    public partial class ImportResult
    {
        public virtual int TotalRows { get; set; }
        public virtual int TotalAdded { get; set; }
        public virtual int TotalUpdated { get; set; }
        public virtual int SuccesfullRows { get; set; }
        public virtual int ErrorRows { get; set; }
        public virtual List<string> Errors { get; set; }
    }

}

C# ImportData DTOs

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>