Participant APIs | REST

Version:

Download Open API Specification

Get a list of annoncements

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

Get a list of annoncements

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
employerId string Required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

Possible values: es en fr

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

Response

array <object>
- 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.