POST api/Alerts/{affiliateId}
Adds the alert.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateId |
The affiliate identifier. |
integer |
Required |
| v |
The requested API version |
string |
Default value is 2.0 |
Body Parameters
The alert.
FilmFlex.Platform.Common.API.Contracts.V2.CreateAlertDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| AlertType |
Gets or sets the type of the alert. |
FilmFlex.Platform.Common.API.Contracts.V2.AlertType |
None. |
| ReferenceId |
Gets or sets the reference identifier. |
globally unique identifier |
None. |
| ExpiryDate |
Gets or sets the expiry date. |
date |
None. |
| Heading |
Gets or sets the heading. |
string |
None. |
| Body |
Gets or sets the body. |
string |
None. |
| Url |
Gets or sets the URL. |
string |
None. |
| SupplierReference |
Gets or sets the supplier reference. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AlertType": 1,
"ReferenceId": "83506319-f049-41a0-84d0-41a69ed23912",
"ExpiryDate": "2025-08-30T01:02:06.4125569+00:00",
"Heading": "sample string 3",
"Body": "sample string 4",
"Url": "sample string 5",
"SupplierReference": "sample string 6"
}
Response Information
Resource Description
Adds the alert.
FilmFlex.Platform.Common.API.Contracts.V2.AlertDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets the identifier. |
integer |
None. |
| AlertType |
Gets or sets the type of the alert. |
FilmFlex.Platform.Common.API.Contracts.V2.AlertType |
None. |
| UserId |
Gets or sets the user identifier. |
globally unique identifier |
None. |
| ReferenceId |
Gets or sets the reference identifier. |
string |
None. |
| DisplayedCount |
Gets or sets the displayed count. |
integer |
None. |
| ExpiryDate |
Gets or sets the expiry date. |
date |
None. |
| Status |
Gets or sets the status. |
FilmFlex.Platform.Common.API.Contracts.V2.AlertStatus |
None. |
| Heading |
Gets or sets the heading. |
string |
None. |
| Body |
Gets or sets the body. |
string |
None. |
| Url |
Gets or sets the URL. |
string |
None. |
| SupplierReference |
Gets or sets the supplier reference. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"AlertType": 1,
"UserId": "183c94a2-8c13-47fb-abbe-a97b9b06d8e7",
"ReferenceId": "sample string 3",
"DisplayedCount": 4,
"ExpiryDate": "2025-08-30T01:02:06.4125569+00:00",
"Status": 1,
"Heading": "sample string 6",
"Body": "sample string 7",
"Url": "sample string 8",
"SupplierReference": "sample string 9"
}