Get a document details

https://qa.api.wealthcare.com/participant/services/document/management/document/{tpaId}/{documentId}

Security

WealthCareOAuth2

OAuth 2.0

Authorization server for WealthCare Administration.

Required Scopes

bensoft_api

Path parameters

tpaId string Required

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

Document Id

Query parameters

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.

Header parameters

Api-Version string

The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

Value: 30.0
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

Response

Response body

DocumentKey integer <int32>
TpaId string
DocumentId string
DocumentName string
Description string
DocumentPostDate string <date-time>
ExpireDate string <date-time>
CategoryId string
CategoryName string
DisplayOrder integer <int32>
AudienceId string
AudienceName string
DocumentFileKey integer <int32>
FileDetails object
- DocumentFileKey integer <int32>
- ContentLength integer <int32>
- ContentType string
- FileName string
- InputStream string <byte>
- Base64 string
- FileFormat enum<string>
  
  Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
LastUpdateDate string <date-time>
Employers array <object>
- TpaId string
- EmprId string
- EmprName string
isLegacyDocument boolean
AssignedOption enum<string>

Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All

DocumentKey integer <int32>
TpaId string
DocumentId string
DocumentName string
Description string
DocumentPostDate string <date-time>
ExpireDate string <date-time>
CategoryId string
CategoryName string
DisplayOrder integer <int32>
AudienceId string
AudienceName string
DocumentFileKey integer <int32>
FileDetails object
- DocumentFileKey integer <int32>
- ContentLength integer <int32>
- ContentType string
- FileName string
- InputStream string <byte>
- Base64 string
- FileFormat enum<string>
  
  Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
LastUpdateDate string <date-time>
Employers array <object>
- TpaId string
- EmprId string
- EmprName string
isLegacyDocument boolean
AssignedOption enum<string>

Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All

Request URL

https://qa.api.wealthcare.com/participant/services/document/management/document/{tpaId}/{documentId}

Authorization Bearer Token

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

documentId (Required) Document Id

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

Api-Version The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

Accept-Language 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.

Response

No response yet.

No response yet.

Participant APIs | REST