| All Verbs | /api/integration |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IntegrationId | body | Guid? | No | The integration reference ID which is the gateway packet id. If the value passed is empty, new packet record will be created. |
| Title | body | string | No | Name or title of the integration |
| Version | body | IntegrationVersion | No | Version information of the integration module. |
| User | body | string | No | User who requested the integration |
| LocalComputer | body | string | No | Local computer where the integration is performed on |
| WinVersion | body | IntegrationWinVersion | No | Windows version information |
| Completed | body | bool | No | Completed status of the integration |
| Status | body | string | No | Status of the integration. |
| StartTime | body | DateTime | No | Start date and time of the integration. |
| EndTime | body | DateTime | No | End date and time of the integration. |
| SettingsFile | body | IntegrationFileModel | No | Settings XML being used in the integration. |
| ResultsFile | body | IntegrationFileModel | No | File (xml) containing the results of the integration |
| IssuesFile | body | IntegrationFileModel | No | File (xml) containing the issues that were identified during integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Major | form | int | No | |
| Minor | form | int | No | |
| Build | form | int | No | |
| Revision | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Version | form | string | No | |
| Build | form | int | No | |
| ServicePack | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| index | form | int | No | |
| Name | form | string | No | |
| Content | form | string | No | |
| ContentType | form | string | No | |
| FileSizeKB | form | int | No | |
| BlobUri | form | string | No | |
| CreatedDate | form | DateTime | No | |
| Notes | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IntegrationId | body | Guid | No | Id of the Gateway Request |
| ResponseStatus | body | ResponseStatus | No | Response Status |
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>