RESTful API
Alerts
Alerts Funding News Liquor Off-road vehicle map

Alerts

Get alerts

Returns a set of data items of type alerts.

Copy GET /api/alerts/alerts
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

AlertLevel

System.String

Read only: False

End

System.DateTimeOffset

Read only: False

Title

System.String

Read only: False

AlertContent

System.String

Read only: False

Start

System.DateTimeOffset

Read only: False

AreaAffected

System.String

Read only: False

OnlyPortal

System.Boolean

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2024-04-29T22:44:54.0863792Z",
    "PublicationDate": "2024-04-29T22:44:54.0863792Z",
    "DateCreated": "2024-04-29T22:44:54.0863792Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "AlertLevel": "sample string 6",
    "End": "2024-04-29T22:44:54.0863792Z",
    "Title": "sample string 8",
    "AlertContent": "sample string 9",
    "Start": "2024-04-29T22:44:54.0863792Z",
    "AreaAffected": "sample string 11",
    "OnlyPortal": true,
    "Provider": "sample string 13"
  },
  {
    "LastModified": "2024-04-29T22:44:54.0863792Z",
    "PublicationDate": "2024-04-29T22:44:54.0863792Z",
    "DateCreated": "2024-04-29T22:44:54.0863792Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "AlertLevel": "sample string 6",
    "End": "2024-04-29T22:44:54.0863792Z",
    "Title": "sample string 8",
    "AlertContent": "sample string 9",
    "Start": "2024-04-29T22:44:54.0863792Z",
    "AreaAffected": "sample string 11",
    "OnlyPortal": true,
    "Provider": "sample string 13"
  }
]

Get alerts by key

Gets alerts item by id.

Copy GET /api/alerts/alerts({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

AlertLevel

System.String

Read only: False

End

System.DateTimeOffset

Read only: False

Title

System.String

Read only: False

AlertContent

System.String

Read only: False

Start

System.DateTimeOffset

Read only: False

AreaAffected

System.String

Read only: False

OnlyPortal

System.Boolean

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2024-04-29T22:44:54.0863792Z",
  "PublicationDate": "2024-04-29T22:44:54.0863792Z",
  "DateCreated": "2024-04-29T22:44:54.0863792Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "AlertLevel": "sample string 6",
  "End": "2024-04-29T22:44:54.0863792Z",
  "Title": "sample string 8",
  "AlertContent": "sample string 9",
  "Start": "2024-04-29T22:44:54.0863792Z",
  "AreaAffected": "sample string 11",
  "OnlyPortal": true,
  "Provider": "sample string 13"
}

Get property

Gets Id property from alerts item.

Copy GET /api/alerts/alerts({key})/property
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

property

System.String

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Id

System.Guid

Read only: False

Resource Format

Response Formats
Copy
application/json
{
  "Id": "d8b2cb67-edb4-4ebe-8472-ac283dcedb6f"
}

Post alerts

Creates a alerts item.

Copy POST /api/alerts/alerts
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

AlertLevel

System.String

Read only: False

End

System.DateTimeOffset

Read only: False

Title

System.String

Read only: False

AlertContent

System.String

Read only: False

Start

System.DateTimeOffset

Read only: False

AreaAffected

System.String

Read only: False

OnlyPortal

System.Boolean

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T22:44:54.0863792Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AlertLevel": "sample string 4",
  "End": "2024-04-29T22:44:54.0863792Z",
  "Title": "sample string 6",
  "AlertContent": "sample string 7",
  "Start": "2024-04-29T22:44:54.0863792Z",
  "AreaAffected": "sample string 9",
  "OnlyPortal": true
}
Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

AlertLevel

System.String

Read only: False

End

System.DateTimeOffset

Read only: False

Title

System.String

Read only: False

AlertContent

System.String

Read only: False

Start

System.DateTimeOffset

Read only: False

AreaAffected

System.String

Read only: False

OnlyPortal

System.Boolean

Read only: False

Provider

System.String

Read only: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2024-04-29T22:44:54.0863792Z",
  "PublicationDate": "2024-04-29T22:44:54.0863792Z",
  "DateCreated": "2024-04-29T22:44:54.0863792Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "AlertLevel": "sample string 6",
  "End": "2024-04-29T22:44:54.0863792Z",
  "Title": "sample string 8",
  "AlertContent": "sample string 9",
  "Start": "2024-04-29T22:44:54.0863792Z",
  "AreaAffected": "sample string 11",
  "OnlyPortal": true,
  "Provider": "sample string 13"
}

Patch alerts by key

Partial update for alerts item.

Copy PATCH /api/alerts/alerts({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

AlertLevel

System.String

Read only: False

End

System.DateTimeOffset

Read only: False

Title

System.String

Read only: False

AlertContent

System.String

Read only: False

Start

System.DateTimeOffset

Read only: False

AreaAffected

System.String

Read only: False

OnlyPortal

System.Boolean

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T22:44:54.0863792Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AlertLevel": "sample string 4",
  "End": "2024-04-29T22:44:54.0863792Z",
  "Title": "sample string 6",
  "AlertContent": "sample string 7",
  "Start": "2024-04-29T22:44:54.0863792Z",
  "AreaAffected": "sample string 9",
  "OnlyPortal": true
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put alerts by key

Full update for alerts item.

Copy PUT /api/alerts/alerts({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True

PublicationDate

System.DateTimeOffset

Read only: False

DateCreated

System.DateTimeOffset

Read only: True

IncludeInSitemap

System.Boolean

Read only: False

UrlName

System.String

Read only: False

AlertLevel

System.String

Read only: False

End

System.DateTimeOffset

Read only: False

Title

System.String

Read only: False

AlertContent

System.String

Read only: False

Start

System.DateTimeOffset

Read only: False

AreaAffected

System.String

Read only: False

OnlyPortal

System.Boolean

Read only: False

Provider

System.String

Read only: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T22:44:54.0863792Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AlertLevel": "sample string 4",
  "End": "2024-04-29T22:44:54.0863792Z",
  "Title": "sample string 6",
  "AlertContent": "sample string 7",
  "Start": "2024-04-29T22:44:54.0863792Z",
  "AreaAffected": "sample string 9",
  "OnlyPortal": true
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete alerts by key

Deletes a alerts item by Id.

Copy DELETE /api/alerts/alerts({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.