NHnhs

GET /v1/announcements/{announcementId}

Changed on

Get an announcement info.

Request

  • Base URL
    https://nhse-${ENV}-innovation-service-admin-functions.azurewebsites.net/api
  • URL
    https://nhse-${ENV}-innovation-service-admin-functions.azurewebsites.net/api/v1/announcements/{announcementId}
  • Auth
    none declared

Path parameters

announcementIdstring uuid required

Response

Announcement info retrieved.

idstring uuid required
titlestring required
userRolesstring[] required
paramsobject nullable required
startsAtstring date-time required
expiresAtstring date-time nullable required
status'SCHEDULED' | 'ACTIVE' | 'DONE' | 'DELETED'
sendEmailboolean required
type'LOG_IN' | 'HOMEPAGE'

Changes

  • bf0b42ebdc02Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from array to object for status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new ACTIVE enum value to the response property for the response status

    • warning

      added the new DELETED enum value to the response property for the response status

    • warning

      added the new DONE enum value to the response property for the response status

    • warning

      added the new SCHEDULED enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • a794f49c303cRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status