Platform Subscription API

<back to all web services

ImportXml

Requires Authentication
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

        Public Partial Class ImportXml
            '''<Summary>
            '''XML string (encoded to base 64) containing data to import into EROS from external system.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="XML string (encoded to base 64) containing data to import into EROS from external system.", Name:="XmlToImport", ParameterType:="query")>
            Public Overridable Property XmlToImport As String

            '''<Summary>
            '''Guid representing the external systems datasource information.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid representing the external systems datasource information.", Name:="SuiteDataSourceInstanceId", ParameterType:="query")>
            Public Overridable Property SuiteDataSourceInstanceId As Guid

            '''<Summary>
            '''Import data type.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Import data type.", Name:="ImportTypeId", ParameterType:="query")>
            Public Overridable Property ImportTypeId As Guid

            '''<Summary>
            '''Data collected from foreign system falls within now and this date.
            '''</Summary>
            <ApiMember(DataType:="DateTime", Description:="Data collected from foreign system falls within now and this date.", Name:="CollectionDate", ParameterType:="query")>
            Public Overridable Property CollectionDate As Date

            '''<Summary>
            '''Bin Row Version of the last update
            '''</Summary>
            <ApiMember(DataType:="byte[]", Description:="Bin Row Version of the last update", Name:="RowVersion", ParameterType:="query")>
            Public Overridable Property RowVersion As Byte()

            '''<Summary>
            '''If true, previous failed import attempts will be removed.
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="If true, previous failed import attempts will be removed.", Name:="RemovePreviousAttempts", ParameterType:="query")>
            Public Overridable Property RemovePreviousAttempts As Boolean
        End Class
    End Namespace
End Namespace

VB.NET ImportXml DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"XmlToImport":"String","CollectionDate":"0001-01-01T00:00:00.0000000","RowVersion":"AA==","RemovePreviousAttempts":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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