Platform Subscription API

<back to all web services

SaveIntegration

"use strict";
export class SaveIntegrationResponse {
    /** @param {{IntegrationId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    IntegrationId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class IntegrationVersion {
    /** @param {{Major?:number,Minor?:number,Build?:number,Revision?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Major;
    /** @type {number} */
    Minor;
    /** @type {number} */
    Build;
    /** @type {number} */
    Revision;
}
export class IntegrationWinVersion {
    /** @param {{Name?:string,Version?:string,Build?:number,ServicePack?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Version;
    /** @type {number} */
    Build;
    /** @type {string} */
    ServicePack;
}
export class IntegrationFileModel {
    /** @param {{index?:number,Name?:string,Content?:string,ContentType?:string,FileSizeKB?:number,BlobUri?:string,CreatedDate?:string,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    index;
    /** @type {string} */
    Name;
    /** @type {string} */
    Content;
    /** @type {string} */
    ContentType;
    /** @type {number} */
    FileSizeKB;
    /** @type {string} */
    BlobUri;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Notes;
}
export class SaveIntegration {
    /** @param {{IntegrationId?:string,Title?:string,Version?:IntegrationVersion,User?:string,LocalComputer?:string,WinVersion?:IntegrationWinVersion,Completed?:boolean,Status?:string,StartTime?:string,EndTime?:string,SettingsFile?:IntegrationFileModel,ResultsFile?:IntegrationFileModel,IssuesFile?:IntegrationFileModel}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The integration reference ID which is the gateway packet id.  If the value passed is empty, new packet record will be created. */
    IntegrationId;
    /**
     * @type {string}
     * @description Name or title of the integration */
    Title;
    /**
     * @type {IntegrationVersion}
     * @description Version information of the integration module. */
    Version;
    /**
     * @type {string}
     * @description User who requested the integration */
    User;
    /**
     * @type {string}
     * @description Local computer where the integration is performed on */
    LocalComputer;
    /**
     * @type {IntegrationWinVersion}
     * @description Windows version information */
    WinVersion;
    /**
     * @type {boolean}
     * @description Completed status of the integration */
    Completed;
    /**
     * @type {string}
     * @description Status of the integration. */
    Status;
    /**
     * @type {string}
     * @description Start date and time of the integration. */
    StartTime;
    /**
     * @type {string}
     * @description End date and time of the integration. */
    EndTime;
    /**
     * @type {IntegrationFileModel}
     * @description Settings XML being used in the integration. */
    SettingsFile;
    /**
     * @type {IntegrationFileModel}
     * @description File (xml) containing the results of the integration */
    ResultsFile;
    /**
     * @type {IntegrationFileModel}
     * @description File (xml) containing the issues that were identified during integration */
    IssuesFile;
}

JavaScript SaveIntegration DTOs

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

<SaveIntegration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Completed>false</Completed>
  <EndTime>0001-01-01T00:00:00</EndTime>
  <IntegrationId>00000000-0000-0000-0000-000000000000</IntegrationId>
  <IssuesFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:BlobUri>String</d2p1:BlobUri>
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:FileSizeKB>0</d2p1:FileSizeKB>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Notes>String</d2p1:Notes>
    <d2p1:index>0</d2p1:index>
  </IssuesFile>
  <LocalComputer>String</LocalComputer>
  <ResultsFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:BlobUri>String</d2p1:BlobUri>
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:FileSizeKB>0</d2p1:FileSizeKB>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Notes>String</d2p1:Notes>
    <d2p1:index>0</d2p1:index>
  </ResultsFile>
  <SettingsFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:BlobUri>String</d2p1:BlobUri>
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:FileSizeKB>0</d2p1:FileSizeKB>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Notes>String</d2p1:Notes>
    <d2p1:index>0</d2p1:index>
  </SettingsFile>
  <StartTime>0001-01-01T00:00:00</StartTime>
  <Status>String</Status>
  <Title>String</Title>
  <User>String</User>
  <Version xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:Build>0</d2p1:Build>
    <d2p1:Major>0</d2p1:Major>
    <d2p1:Minor>0</d2p1:Minor>
    <d2p1:Revision>0</d2p1:Revision>
  </Version>
  <WinVersion xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:Build>0</d2p1:Build>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ServicePack>String</d2p1:ServicePack>
    <d2p1:Version>String</d2p1:Version>
  </WinVersion>
</SaveIntegration>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaveIntegrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <IntegrationId>00000000-0000-0000-0000-000000000000</IntegrationId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SaveIntegrationResponse>