Participant APIs | REST

Version:

Download Open API Specification

Get a list of downloadable forms

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

Get a list of downloadable forms

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.

Query parameters

decrypt integer <int32>

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

Response

array <object>
- FileDetails object
  
  File Details
  - FileKey integer <int32>
    
    File Key
  - FileFormat enum<string>
    
    Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
  - ContentLength integer <int32>
    
    The file length, in bytes.
  - ContentType string
    
    The MIME content type of the uploaded file.
  - FileName string
    
    The name of the client's file, including the directory path.
  - InputStream string <byte>
    
    A System.IO.Stream pointing to a file.
  - Base64 string
    
    The string representation in Base 64 of the file content.
- 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.