POST api/Alert/adhoc

Request Information

URI Parameters

None.

Body Parameters

AlertDto
NameDescriptionTypeAdditional information
Id

integer

None.

Deleted

boolean

None.

Name

string

None.

Client

ListItemDto

None.

Schedule

ScheduleDto

None.

Enabled

boolean

None.

LastArticleDate

date

None.

Recipients

Collection of AlertRecipientDto

None.

AdHocRecipients

Collection of AlertAdHocRecipientDto

None.

FacetedSearches

Collection of AlertBalticFacetedSearchDto

None.

Articles

Collection of AlertMonitoringArticleDto

None.

Groupings

Collection of AlertGroupingDto

None.

IsTest

boolean

None.

TestRecipient

string

None.

IsAdhoc

boolean

None.

Deduplicate

boolean

None.

DedeuplicateMethod

AlertDedeuplicateMethod

None.

ShowToc

boolean

None.

ShowHeadlinesInToc

boolean

None.

TextFormat

AlertTextFormat

None.

ContextualExtractTextSize

integer

None.

CustomGrouping

boolean

None.

RestrictToExplicitGroupings

boolean

None.

SendEmptyAlert

boolean

None.

HeaderLogoUrl

string

None.

HeaderColour

string

None.

MainTitleBackgroundColour

string

None.

MainTitleFontColour

string

None.

SubTitleBackgroundColour

string

None.

SubTitleFontColour

string

None.

ArticleHeadlineColour

string

None.

HighlightTextBackgroundColour

string

None.

HighlightFeedKeywords

boolean

None.

HighlightTagKeywordsForGroup

boolean

None.

HideArticleLinks

boolean

None.

Template

ListItemDto

None.

ArticleType

ArticleType

None.

ShowSentiment

boolean

None.

ShowAve

boolean

None.

ShowReach

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "deleted": true,
  "name": "sample string 3",
  "client": {
    "id": 1,
    "name": "sample string 2"
  },
  "schedule": {
    "id": 1,
    "deleted": true,
    "scheduleType": 1,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true,
    "startTime": 10,
    "endTime": 11,
    "times": [
      {
        "id": 1,
        "deleted": true,
        "time": 3
      },
      {
        "id": 1,
        "deleted": true,
        "time": 3
      }
    ],
    "lastRun": "2025-05-02T19:36:49.2645219+00:00"
  },
  "enabled": true,
  "lastArticleDate": "2025-05-02T19:36:49.2645219+00:00",
  "recipients": [
    {
      "id": 1,
      "deleted": true,
      "balticUser": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    {
      "id": 1,
      "deleted": true,
      "balticUser": {
        "id": 1,
        "name": "sample string 2"
      }
    }
  ],
  "adHocRecipients": [
    {
      "id": 1,
      "deleted": true,
      "email": "sample string 3"
    },
    {
      "id": 1,
      "deleted": true,
      "email": "sample string 3"
    }
  ],
  "facetedSearches": [
    {
      "id": 1,
      "deleted": true,
      "balticFacetedSearch": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    {
      "id": 1,
      "deleted": true,
      "balticFacetedSearch": {
        "id": 1,
        "name": "sample string 2"
      }
    }
  ],
  "articles": [
    {
      "id": 1,
      "deleted": true,
      "article": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    {
      "id": 1,
      "deleted": true,
      "article": {
        "id": 1,
        "name": "sample string 2"
      }
    }
  ],
  "groupings": [
    {
      "id": 1,
      "deleted": true,
      "field": 1,
      "orderByDescending": true,
      "ordinality": 4,
      "sortValues": "sample string 5"
    },
    {
      "id": 1,
      "deleted": true,
      "field": 1,
      "orderByDescending": true,
      "ordinality": 4,
      "sortValues": "sample string 5"
    }
  ],
  "isTest": true,
  "testRecipient": "sample string 7",
  "isAdhoc": true,
  "deduplicate": true,
  "dedeuplicateMethod": 0,
  "showToc": true,
  "showHeadlinesInToc": true,
  "textFormat": 1,
  "contextualExtractTextSize": 12,
  "customGrouping": true,
  "restrictToExplicitGroupings": true,
  "sendEmptyAlert": true,
  "headerLogoUrl": "sample string 16",
  "headerColour": "sample string 17",
  "mainTitleBackgroundColour": "sample string 18",
  "mainTitleFontColour": "sample string 19",
  "subTitleBackgroundColour": "sample string 20",
  "subTitleFontColour": "sample string 21",
  "articleHeadlineColour": "sample string 22",
  "highlightTextBackgroundColour": "sample string 23",
  "highlightFeedKeywords": true,
  "highlightTagKeywordsForGroup": true,
  "hideArticleLinks": true,
  "template": {
    "id": 1,
    "name": "sample string 2"
  },
  "articleType": 1,
  "showSentiment": true,
  "showAve": true,
  "showReach": true
}

text/plain

Sample:
{"id":1,"deleted":true,"name":"sample string 3","client":{"id":1,"name":"sample string 2"},"schedule":{"id":1,"deleted":true,"scheduleType":1,"monday":true,"tuesday":true,"wednesday":true,"thursday":true,"friday":true,"saturday":true,"sunday":true,"startTime":10,"endTime":11,"times":[{"id":1,"deleted":true,"time":3},{"id":1,"deleted":true,"time":3}],"lastRun":"2025-05-02T19:36:49.2645219+00:00"},"enabled":true,"lastArticleDate":"2025-05-02T19:36:49.2645219+00:00","recipients":[{"id":1,"deleted":true,"balticUser":{"id":1,"name":"sample string 2"}},{"id":1,"deleted":true,"balticUser":{"id":1,"name":"sample string 2"}}],"adHocRecipients":[{"id":1,"deleted":true,"email":"sample string 3"},{"id":1,"deleted":true,"email":"sample string 3"}],"facetedSearches":[{"id":1,"deleted":true,"balticFacetedSearch":{"id":1,"name":"sample string 2"}},{"id":1,"deleted":true,"balticFacetedSearch":{"id":1,"name":"sample string 2"}}],"articles":[{"id":1,"deleted":true,"article":{"id":1,"name":"sample string 2"}},{"id":1,"deleted":true,"article":{"id":1,"name":"sample string 2"}}],"groupings":[{"id":1,"deleted":true,"field":1,"orderByDescending":true,"ordinality":4,"sortValues":"sample string 5"},{"id":1,"deleted":true,"field":1,"orderByDescending":true,"ordinality":4,"sortValues":"sample string 5"}],"isTest":true,"testRecipient":"sample string 7","isAdhoc":true,"deduplicate":true,"dedeuplicateMethod":0,"showToc":true,"showHeadlinesInToc":true,"textFormat":1,"contextualExtractTextSize":12,"customGrouping":true,"restrictToExplicitGroupings":true,"sendEmptyAlert":true,"headerLogoUrl":"sample string 16","headerColour":"sample string 17","mainTitleBackgroundColour":"sample string 18","mainTitleFontColour":"sample string 19","subTitleBackgroundColour":"sample string 20","subTitleFontColour":"sample string 21","articleHeadlineColour":"sample string 22","highlightTextBackgroundColour":"sample string 23","highlightFeedKeywords":true,"highlightTagKeywordsForGroup":true,"hideArticleLinks":true,"template":{"id":1,"name":"sample string 2"},"articleType":1,"showSentiment":true,"showAve":true,"showReach":true}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/plain

Sample:

Sample not available.