Participant APIs | REST

Version:
Download Open API Specification

Update a document

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

Update a document

  • tpaId string Required

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

  • refresh boolean

    True: return document after it's saved, False: return empty after it's saved.

  • decrypt integer <int32>

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

  • TpaId string
  • DocumentId string
  • DocumentName string
  • Description string
  • DocumentPostDate string <date-time>
  • ExpireDate string <date-time>
  • CategoryId string
  • AudienceId string
  • 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
  • Employers array <object>
    • TpaId string
    • EmprId string
    • EmprName string
  • LastUpdateDate string <date-time>
  • LegacyDocumentKey integer <int32>
  • 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