DigiOffice API Services Services

ImportData

Import entity data into DigiOffice (v1)

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

**ImportData** Parameters:
Name	Parameter	Data Type	Required	Description
EntityType	body	string	Yes	Entityname in which the data will be imported
ErrorField	body	string	No	Reports errors with a reference to this field (for example ID)
ContinueOnError	body	bool	No	Should import continue on errors? (Default true)
Rows	body	List<Row>	Yes	Rows to be imported
FixedValues	body	List<FixedValue>	No	Additional values to be imported on every row

**Row** Parameters:
Name	Parameter	Data Type	Required	Description
Fields	form	List<ImportField>	No

**ImportField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**FixedValue** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**ImportResult** Parameters:
Name	Parameter	Data Type	Required
TotalRows	form	int	No
TotalAdded	form	int	No
TotalUpdated	form	int	No
SuccesfullRows	form	int	No
ErrorRows	form	int	No
Errors	form	List<string>	No

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>