GET api/Alerts/Current/{affiliateId}/{type}

Gets current alerts for given type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

The affiliate identifier.

integer

Required

type

The type.

FilmFlex.Platform.Common.API.Contracts.V2.AlertType

Required

v

The requested API version

string

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Gets current alerts for given type.

Collection of FilmFlex.Platform.Common.API.Contracts.V2.AlertDTO
NameDescriptionTypeAdditional 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": "dfe38fdc-ce66-4d67-90f5-e0175da6d7cc",
    "ReferenceId": "sample string 3",
    "DisplayedCount": 4,
    "ExpiryDate": "2025-08-31T10:37:45.7984581+00:00",
    "Status": 1,
    "Heading": "sample string 6",
    "Body": "sample string 7",
    "Url": "sample string 8",
    "SupplierReference": "sample string 9"
  },
  {
    "Id": 1,
    "AlertType": 1,
    "UserId": "dfe38fdc-ce66-4d67-90f5-e0175da6d7cc",
    "ReferenceId": "sample string 3",
    "DisplayedCount": 4,
    "ExpiryDate": "2025-08-31T10:37:45.7984581+00:00",
    "Status": 1,
    "Heading": "sample string 6",
    "Body": "sample string 7",
    "Url": "sample string 8",
    "SupplierReference": "sample string 9"
  }
]