Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Adding and viewing Attachments

Adding and viewing Notes

Adding and viewing Transactions

Viewing and resending Correspondence

Request a Case to be withdrawn

Request a Case to be reopened




Anchor
FindingAndViewingCases
FindingAndViewingCases

...

  • To add Attachments, call www.example.com/QFDAPI/v1/claim/attachments/add with your valid ClaimId and AttachmentList, a list of attachments you want to add
  • Each Attachment in the AttachmentList should contain:
    • FileName
    • Category
    • Label
    • DocumentStream

Anchor
AddingAndViewingNotes
AddingAndViewingNotes

Adding and viewing Notes

  • Follow the Finding and viewing Cases instructions to get a valid ClaimId
  • Use the endpoint, www.example.com/QFDAPI/v1/notes/list to get a list of notes linked to a claim
  • The LinkReference ID returned in /notes/list can be used to retrieve a specific note
  • Use the endpoint, www.example.com/QFDAPI/v1/notes/retrieve to retrieve a specific note by passing in the LinkReference value

...

  • To add Notes, call www.example.com/QFDAPI/v1/claim/notes/add with your valid ClaimId and Note details:
    • Subject
    • Note




Anchor
AddingAndViewingTransactions
AddingAndViewingTransactions

Adding and viewing Transactions

  • Follow the Finding and viewing Cases instructions to get a valid ClaimId
  • Use the endpoint, www.example.com/QFDAPI/v1/transactions/list to get a list of transactions linked to a claim
  • The /transaction/list endpoint returns all details about each transaction

...

  • To add Transactions, call www.example.com/QFDAPI/v1/claim/transactions/add with your valid ClaimId and list of Transactions, TransactionList
  • Each Transaction in TransactionList needs to have a valid TransactionId



Anchor
ViewingAndResendingCorrespondence
ViewingAndResendingCorrespondence

Viewing and resending Correspondence

  • Follow the Finding and viewing Cases instructions to get a valid ClaimId
  • Use the endpoint, www.example.com/QFDAPI/v1/correspondence/list to get a list of Correspondence linked to a claim as well as details about the Correspondence
  • The LinkReference ID returned in /correspondence/list can be used to retrieve a specific correspondence
  • Use the endpoint, www.example.com/QFDAPI/v1/correspondence/retrieve to retrieve a specific correspondence by passing in the LinkReference value
    • This endpoint returns EmailStyleMarkup and Body

...

  • To resend a correspondence, call www.example.com/QFDAPI/v1/claim/correspondence/resend with your valid ClaimId and Correspondence LinkReference ID

Anchor
RequestCaseWithdrawn
RequestCaseWithdrawn

Request a Case to be withdrawn

  • Follow the Finding and viewing Cases instructions to get a valid ClaimId
  • Use the endpoint, www.example.com/QFDAPI/v1/claim/withdrawRequest to request a claim to be withdrawn
  • /claim/withdrawRequest must be called with a valid ClaimId and must be provided a WithdrawalReason

Anchor
RequestCaseReopened
RequestCaseReopened

Request a Case to be reopened

  • Follow the Finding and viewing Cases instructions to get a valid ClaimId
  • Use the endpoint, www.example.com/QFDAPI/v1/claim/reopenRequest to request a claim to be reopened
  • /claim/reopenRequest must be called with a valid ClaimId and must be provided a ReopenReason and TransactionList
  • TransactionList contains a list of TransactionIds of the specific Transactions to be reopened
  • ReopenNewInformation is an optional field for any new information about the claim 

...