| All Verbs | /api/integration |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<ApiResponse(Description="Track integration result")>]
[<AllowNullLiteral>]
type SaveIntegrationResponse() =
member val IntegrationId:Guid = new Guid() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type IntegrationVersion() =
member val Major:Int32 = new Int32() with get,set
member val Minor:Int32 = new Int32() with get,set
member val Build:Int32 = new Int32() with get,set
member val Revision:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type IntegrationWinVersion() =
member val Name:String = null with get,set
member val Version:String = null with get,set
member val Build:Int32 = new Int32() with get,set
member val ServicePack:String = null with get,set
[<AllowNullLiteral>]
type IntegrationFileModel() =
member val index:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Content:String = null with get,set
member val ContentType:String = null with get,set
member val FileSizeKB:Int32 = new Int32() with get,set
member val BlobUri:String = null with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val Notes:String = null with get,set
[<AllowNullLiteral>]
type 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")>]
member val IntegrationId:Guid = new Guid() with get,set
///<summary>
///Name or title of the integration
///</summary>
[<ApiMember(DataType="string", Description="Name or title of the integration", Name="Title")>]
member val Title:String = null with get,set
///<summary>
///Version information of the integration module.
///</summary>
[<ApiMember(DataType="IntegrationVersion", Description="Version information of the integration module.", Name="Version")>]
member val Version:IntegrationVersion = null with get,set
///<summary>
///User who requested the integration
///</summary>
[<ApiMember(DataType="string", Description="User who requested the integration", Name="User")>]
member val User:String = null with 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")>]
member val LocalComputer:String = null with get,set
///<summary>
///Windows version information
///</summary>
[<ApiMember(DataType="IntegrationWinVersion", Description="Windows version information", Name="WinVersion")>]
member val WinVersion:IntegrationWinVersion = null with get,set
///<summary>
///Completed status of the integration
///</summary>
[<ApiMember(DataType="bool", Description="Completed status of the integration", Name="Completed")>]
member val Completed:Boolean = new Boolean() with get,set
///<summary>
///Status of the integration.
///</summary>
[<ApiMember(DataType="string", Description="Status of the integration.", Name="Status")>]
member val Status:String = null with get,set
///<summary>
///Start date and time of the integration.
///</summary>
[<ApiMember(DataType="DateTime", Description="Start date and time of the integration.", Name="StartTime")>]
member val StartTime:DateTime = new DateTime() with get,set
///<summary>
///End date and time of the integration.
///</summary>
[<ApiMember(DataType="DateTime", Description="End date and time of the integration.", Name="EndTime")>]
member val EndTime:DateTime = new DateTime() with get,set
///<summary>
///Settings XML being used in the integration.
///</summary>
[<ApiMember(DataType="IntegrationFileModel", Description="Settings XML being used in the integration.", Name="SettingsFile")>]
member val SettingsFile:IntegrationFileModel = null with 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")>]
member val ResultsFile:IntegrationFileModel = null with 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")>]
member val IssuesFile:IntegrationFileModel = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Title: String,
Version:
{
Major: 0,
Minor: 0,
Build: 0,
Revision: 0
},
User: String,
LocalComputer: String,
WinVersion:
{
Name: String,
Version: String,
Build: 0,
ServicePack: String
},
Completed: False,
Status: String,
StartTime: 0001-01-01,
EndTime: 0001-01-01,
SettingsFile:
{
index: 0,
Name: String,
Content: String,
ContentType: String,
FileSizeKB: 0,
BlobUri: String,
CreatedDate: 0001-01-01,
Notes: String
},
ResultsFile:
{
index: 0,
Name: String,
Content: String,
ContentType: String,
FileSizeKB: 0,
BlobUri: String,
CreatedDate: 0001-01-01,
Notes: String
},
IssuesFile:
{
index: 0,
Name: String,
Content: String,
ContentType: String,
FileSizeKB: 0,
BlobUri: String,
CreatedDate: 0001-01-01,
Notes: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}