Platform Subscription API

<back to all web services

ImportXml

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImportXml:
    # @ApiMember(DataType="string", Description="XML string (encoded to base 64) containing data to import into EROS from external system.", Name="XmlToImport", ParameterType="query")
    xml_to_import: Optional[str] = None
    """
    XML string (encoded to base 64) containing data to import into EROS from external system.
    """


    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId", ParameterType="query")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems datasource information.
    """


    # @ApiMember(DataType="Guid", Description="Import data type.", Name="ImportTypeId", ParameterType="query")
    import_type_id: Optional[str] = None
    """
    Import data type.
    """


    # @ApiMember(DataType="DateTime", Description="Data collected from foreign system falls within now and this date.", Name="CollectionDate", ParameterType="query")
    collection_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Data collected from foreign system falls within now and this date.
    """


    # @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="RowVersion", ParameterType="query")
    row_version: Optional[bytes] = None
    """
    Bin Row Version of the last update
    """


    # @ApiMember(DataType="bool", Description="If true, previous failed import attempts will be removed.", Name="RemovePreviousAttempts", ParameterType="query")
    remove_previous_attempts: bool = False
    """
    If true, previous failed import attempts will be removed.
    """

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