Platform Subscription API

<back to all web services

ImportXml

Requires Authentication
"use strict";
export class ImportXml {
    /** @param {{XmlToImport?:string,SuiteDataSourceInstanceId?:string,ImportTypeId?:string,CollectionDate?:string,RowVersion?:string,RemovePreviousAttempts?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description XML string (encoded to base 64) containing data to import into EROS from external system. */
    XmlToImport;
    /**
     * @type {string}
     * @description Guid representing the external systems datasource information. */
    SuiteDataSourceInstanceId;
    /**
     * @type {string}
     * @description Import data type. */
    ImportTypeId;
    /**
     * @type {string}
     * @description Data collected from foreign system falls within now and this date. */
    CollectionDate;
    /**
     * @type {string}
     * @description Bin Row Version of the last update */
    RowVersion;
    /**
     * @type {boolean}
     * @description If true, previous failed import attempts will be removed. */
    RemovePreviousAttempts;
}

JavaScript ImportXml DTOs

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.

POST /jsv/reply/ImportXml HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	XmlToImport: String,
	CollectionDate: 0001-01-01,
	RowVersion: AA==,
	RemovePreviousAttempts: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}