Platform Subscription API

<back to all web services

ImportXml

Requires Authentication
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ImportXml
    {
        /**
        * XML string (encoded to base 64) containing data to import into EROS from external system.
        */
        @ApiMember(DataType="string", Description="XML string (encoded to base 64) containing data to import into EROS from external system.", Name="XmlToImport", ParameterType="query")
        public String XmlToImport = null;

        /**
        * Guid representing the external systems datasource information.
        */
        @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId", ParameterType="query")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * Import data type.
        */
        @ApiMember(DataType="Guid", Description="Import data type.", Name="ImportTypeId", ParameterType="query")
        public UUID ImportTypeId = null;

        /**
        * Data collected from foreign system falls within now and this date.
        */
        @ApiMember(DataType="DateTime", Description="Data collected from foreign system falls within now and this date.", Name="CollectionDate", ParameterType="query")
        public Date CollectionDate = null;

        /**
        * Bin Row Version of the last update
        */
        @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="RowVersion", ParameterType="query")
        public byte[] RowVersion = null;

        /**
        * If true, previous failed import attempts will be removed.
        */
        @ApiMember(DataType="bool", Description="If true, previous failed import attempts will be removed.", Name="RemovePreviousAttempts", ParameterType="query")
        public Boolean RemovePreviousAttempts = null;
        
        public String getXmlToImport() { return XmlToImport; }
        public ImportXml setXmlToImport(String value) { this.XmlToImport = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public ImportXml setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public UUID getImportTypeId() { return ImportTypeId; }
        public ImportXml setImportTypeId(UUID value) { this.ImportTypeId = value; return this; }
        public Date getCollectionDate() { return CollectionDate; }
        public ImportXml setCollectionDate(Date value) { this.CollectionDate = value; return this; }
        public byte[] getRowVersion() { return RowVersion; }
        public ImportXml setRowVersion(byte[] value) { this.RowVersion = value; return this; }
        public Boolean isRemovePreviousAttempts() { return RemovePreviousAttempts; }
        public ImportXml setRemovePreviousAttempts(Boolean value) { this.RemovePreviousAttempts = value; return this; }
    }

}

Java 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
	}
}