Platform Subscription API

<back to all web services

ImportXml

Requires Authentication

export class ImportXml
{
    /** @description 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 XmlToImport: string;

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

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

    /** @description 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 CollectionDate: string;

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

    /** @description 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 RemovePreviousAttempts: boolean;

    public constructor(init?: Partial<ImportXml>) { (Object as any).assign(this, init); }
}

TypeScript ImportXml DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

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

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