Platform Subscription API

<back to all web services

ImportXml

Requires Authentication
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class ImportXml implements IConvertible
{
    /**
    * 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")
    String? XmlToImport;

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

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

    /**
    * 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")
    DateTime? CollectionDate;

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

    /**
    * 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")
    bool? RemovePreviousAttempts;

    ImportXml({this.XmlToImport,this.SuiteDataSourceInstanceId,this.ImportTypeId,this.CollectionDate,this.RowVersion,this.RemovePreviousAttempts});
    ImportXml.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        XmlToImport = json['XmlToImport'];
        SuiteDataSourceInstanceId = json['SuiteDataSourceInstanceId'];
        ImportTypeId = json['ImportTypeId'];
        CollectionDate = JsonConverters.fromJson(json['CollectionDate'],'DateTime',context!);
        RowVersion = JsonConverters.fromJson(json['RowVersion'],'Uint8List',context!);
        RemovePreviousAttempts = json['RemovePreviousAttempts'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'XmlToImport': XmlToImport,
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'ImportTypeId': ImportTypeId,
        'CollectionDate': JsonConverters.toJson(CollectionDate,'DateTime',context!),
        'RowVersion': JsonConverters.toJson(RowVersion,'Uint8List',context!),
        'RemovePreviousAttempts': RemovePreviousAttempts
    };

    getTypeName() => "ImportXml";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'production_eros_platform_apisubscription.azurewebsites.net', types: <String, TypeInfo> {
    'ImportXml': TypeInfo(TypeOf.Class, create:() => ImportXml()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
});

Dart ImportXml DTOs

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.

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

<ImportXml xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <CollectionDate>0001-01-01T00:00:00</CollectionDate>
  <ImportTypeId>00000000-0000-0000-0000-000000000000</ImportTypeId>
  <RemovePreviousAttempts>false</RemovePreviousAttempts>
  <RowVersion>AA==</RowVersion>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
  <XmlToImport>String</XmlToImport>
</ImportXml>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>