All Verbs | /api/integration |
---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Causal.Common.Entity;
namespace Eros.Causal.Common.Entity
{
public partial class IntegrationFileModel
{
public virtual int index { get; set; }
public virtual string Name { get; set; }
public virtual string Content { get; set; }
public virtual string ContentType { get; set; }
public virtual int FileSizeKB { get; set; }
public virtual string BlobUri { get; set; }
public virtual DateTime CreatedDate { get; set; }
public virtual string Notes { get; set; }
}
public partial class IntegrationVersion
{
public virtual int Major { get; set; }
public virtual int Minor { get; set; }
public virtual int Build { get; set; }
public virtual int Revision { get; set; }
}
public partial class IntegrationWinVersion
{
public virtual string Name { get; set; }
public virtual string Version { get; set; }
public virtual int Build { get; set; }
public virtual string ServicePack { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
public partial class SaveIntegration
{
///<summary>
///The integration reference ID which is the gateway packet id. If the value passed is empty, new packet record will be created.
///</summary>
[ApiMember(DataType="Guid?", Description="The integration reference ID which is the gateway packet id. If the value passed is empty, new packet record will be created.", Name="IntegrationId")]
public virtual Guid IntegrationId { get; set; }
///<summary>
///Name or title of the integration
///</summary>
[ApiMember(DataType="string", Description="Name or title of the integration", Name="Title")]
public virtual string Title { get; set; }
///<summary>
///Version information of the integration module.
///</summary>
[ApiMember(DataType="IntegrationVersion", Description="Version information of the integration module.", Name="Version")]
public virtual IntegrationVersion Version { get; set; }
///<summary>
///User who requested the integration
///</summary>
[ApiMember(DataType="string", Description="User who requested the integration", Name="User")]
public virtual string User { get; set; }
///<summary>
///Local computer where the integration is performed on
///</summary>
[ApiMember(DataType="string", Description="Local computer where the integration is performed on", Name="LocalComputer")]
public virtual string LocalComputer { get; set; }
///<summary>
///Windows version information
///</summary>
[ApiMember(DataType="IntegrationWinVersion", Description="Windows version information", Name="WinVersion")]
public virtual IntegrationWinVersion WinVersion { get; set; }
///<summary>
///Completed status of the integration
///</summary>
[ApiMember(DataType="bool", Description="Completed status of the integration", Name="Completed")]
public virtual bool Completed { get; set; }
///<summary>
///Status of the integration.
///</summary>
[ApiMember(DataType="string", Description="Status of the integration.", Name="Status")]
public virtual string Status { get; set; }
///<summary>
///Start date and time of the integration.
///</summary>
[ApiMember(DataType="DateTime", Description="Start date and time of the integration.", Name="StartTime")]
public virtual DateTime StartTime { get; set; }
///<summary>
///End date and time of the integration.
///</summary>
[ApiMember(DataType="DateTime", Description="End date and time of the integration.", Name="EndTime")]
public virtual DateTime EndTime { get; set; }
///<summary>
///Settings XML being used in the integration.
///</summary>
[ApiMember(DataType="IntegrationFileModel", Description="Settings XML being used in the integration.", Name="SettingsFile")]
public virtual IntegrationFileModel SettingsFile { get; set; }
///<summary>
///File (xml) containing the results of the integration
///</summary>
[ApiMember(DataType="IntegrationFileModel", Description="File (xml) containing the results of the integration", Name="ResultsFile")]
public virtual IntegrationFileModel ResultsFile { get; set; }
///<summary>
///File (xml) containing the issues that were identified during integration
///</summary>
[ApiMember(DataType="IntegrationFileModel", Description="File (xml) containing the issues that were identified during integration", Name="IssuesFile")]
public virtual IntegrationFileModel IssuesFile { get; set; }
}
[ApiResponse(Description="Track integration result")]
public partial class SaveIntegrationResponse
{
public virtual Guid IntegrationId { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
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>