| All Verbs | /api/integration |
|---|
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.ServiceModel
Imports Eros.Causal.Common.Entity
Namespace Global
Namespace Eros.Causal.Common.Entity
Public Partial Class IntegrationFileModel
Public Overridable Property index As Integer
Public Overridable Property Name As String
Public Overridable Property Content As String
Public Overridable Property ContentType As String
Public Overridable Property FileSizeKB As Integer
Public Overridable Property BlobUri As String
Public Overridable Property CreatedDate As Date
Public Overridable Property Notes As String
End Class
Public Partial Class IntegrationVersion
Public Overridable Property Major As Integer
Public Overridable Property Minor As Integer
Public Overridable Property Build As Integer
Public Overridable Property Revision As Integer
End Class
Public Partial Class IntegrationWinVersion
Public Overridable Property Name As String
Public Overridable Property Version As String
Public Overridable Property Build As Integer
Public Overridable Property ServicePack As String
End Class
End Namespace
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 Overridable Property IntegrationId As Guid
'''<Summary>
'''Name or title of the integration
'''</Summary>
<ApiMember(DataType:="string", Description:="Name or title of the integration", Name:="Title")>
Public Overridable Property Title As String
'''<Summary>
'''Version information of the integration module.
'''</Summary>
<ApiMember(DataType:="IntegrationVersion", Description:="Version information of the integration module.", Name:="Version")>
Public Overridable Property Version As IntegrationVersion
'''<Summary>
'''User who requested the integration
'''</Summary>
<ApiMember(DataType:="string", Description:="User who requested the integration", Name:="User")>
Public Overridable Property User As String
'''<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 Overridable Property LocalComputer As String
'''<Summary>
'''Windows version information
'''</Summary>
<ApiMember(DataType:="IntegrationWinVersion", Description:="Windows version information", Name:="WinVersion")>
Public Overridable Property WinVersion As IntegrationWinVersion
'''<Summary>
'''Completed status of the integration
'''</Summary>
<ApiMember(DataType:="bool", Description:="Completed status of the integration", Name:="Completed")>
Public Overridable Property Completed As Boolean
'''<Summary>
'''Status of the integration.
'''</Summary>
<ApiMember(DataType:="string", Description:="Status of the integration.", Name:="Status")>
Public Overridable Property Status As String
'''<Summary>
'''Start date and time of the integration.
'''</Summary>
<ApiMember(DataType:="DateTime", Description:="Start date and time of the integration.", Name:="StartTime")>
Public Overridable Property StartTime As Date
'''<Summary>
'''End date and time of the integration.
'''</Summary>
<ApiMember(DataType:="DateTime", Description:="End date and time of the integration.", Name:="EndTime")>
Public Overridable Property EndTime As Date
'''<Summary>
'''Settings XML being used in the integration.
'''</Summary>
<ApiMember(DataType:="IntegrationFileModel", Description:="Settings XML being used in the integration.", Name:="SettingsFile")>
Public Overridable Property SettingsFile As IntegrationFileModel
'''<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 Overridable Property ResultsFile As IntegrationFileModel
'''<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 Overridable Property IssuesFile As IntegrationFileModel
End Class
<ApiResponse(Description:="Track integration result")>
Public Partial Class SaveIntegrationResponse
Public Overridable Property IntegrationId As Guid
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
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
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/json
Content-Type: application/json
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-01T00:00:00.0000000","EndTime":"0001-01-01T00:00:00.0000000","SettingsFile":{"index":0,"Name":"String","Content":"String","ContentType":"String","FileSizeKB":0,"BlobUri":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Notes":"String"},"ResultsFile":{"index":0,"Name":"String","Content":"String","ContentType":"String","FileSizeKB":0,"BlobUri":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Notes":"String"},"IssuesFile":{"index":0,"Name":"String","Content":"String","ContentType":"String","FileSizeKB":0,"BlobUri":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Notes":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}