Participant APIs | REST

Version:
Download Open API Specification

Get annoncement details

https://beta.api.wealthcare.com/participant/services/portalinfo/announcement/{tpaId}

Retrieve detailed information about a specific announcement associated with a given TPA ID. This endpoint is useful for obtaining the latest updates or notifications relevant to participants.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.

  • Accept-Language enum<string>

    Specify the participant’s language preference for the response. Valid options are "es" for Spanish, "en" for English, and "fr" for French. If not specified or if an invalid value is provided, the response will default to English. Note that if a requested language lacks a translation for a specific field, the English version will be returned.

    Possible values: es en fr
  • infoKey integer <int32> Required

    The unique identifier for the portal information being requested. This integer value is essential for fetching the correct announcement details.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

  • TpaId string

    Unique id of the TPA

  • InfoKey integer <int32>

    Portal Info Key

  • InfoName string

    Portal Info Name

  • InfoDesc string

    Portal Info Description

  • InfoDate string <date-time>

    Portal Info Date

  • ExpireDate string <date-time>

    Portal Info Expiration Date

  • LastUpdateDate string <date-time>

    Date in which Portal Info was last updated

  • EmployerIdList array <string>

    List of Employer IDs

  • VisibilityIsGlobal boolean

    Global Visibility. True = Visible to the participant. False = Not visible to the participant.

  • VisibilityIsNone boolean

    No Visibility. True = Not visible to the participant. False = Visible to the participant.