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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EntityType: String,
	ErrorField: String,
	ContinueOnError: False,
	Rows: 
	[
		{
			Fields: 
			[
				{
					Name: String,
					Value: String
				}
			]
		}
	],
	FixedValues: 
	[
		{
			Name: String,
			Value: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TotalRows: 0,
	TotalAdded: 0,
	TotalUpdated: 0,
	SuccesfullRows: 0,
	ErrorRows: 0,
	Errors: 
	[
		String
	]
}