Participant APIs | REST

Version:

Download Open API Specification

Returns a list of communications

https://api.wealthcare.com/participant/services/communications/{tpaId}/{employerId}/{participantId}

This operation will retrieve a list of notifications, alerts, and other messages sent to participants.

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.
participantId string Required

Participant Id

Query parameters

includeLegacy boolean

Include legacy communications
type string

Filter by communication type - please see 'Communication Types' table below.
showLetter string

Include letter communications (Manual Claim letter, Reimbursement letters, Receipt Notification letters)
decrypt integer <int32>

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

Response

array <object>
- CommunicationRequestKey integer <int64>
  
  A system generated key used to identify the particular communication message.
- CommunicationRuleType integer
  
  A numerical value indicating the type of communication
- CommunicationRuleKey integer <int32>
  
  A system generated ID used to identify the template used to generate this communication message
- CommunicationRuleName string
  
  The name of the template used to generate this communication message
- CommunicationRuleChannels integer
  
  Specifies the delivery channel through which the participant received the communication message. This is a bitwise value which can indicate multiple options (I.e., a 3 represents both email and SMS)
- Subject string
  
  The title of the communication message; sent as the subject in an email message.
- InsertDte string <date-time>
  
  The date the communication message was created
- UpdateDte string <date-time>
  
  The date the communication message was last updated
- CommunicationVersion integer <int32>
  
  Indicates which version of communication this is. A one indicates the standard WCA communication offerings. A two will be used for future offerings.
- ReadDte integer <int32>
  
  The date the communication message was read by the participant