| 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 .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"}}}