academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Health-insurance-profile-communication-logs [Beta] → Find health insurance profile communication log entries.

AI-generated

Summary

Retrieves health insurance profile communication log entries from the academyFIVE API. Optionally filter by log ID, processing status, action type, referenced log ID, student profile ID, or authority request/response ID, and set the page number and size.

Inputs

  • filter[id] — Filter by a communication log ID.
  • filter[status] — Filter by processing status code, including outstanding, payment, message, correction, cancellation, and resend statuses.
  • filter[actionType] — Filter by action type: 60/61 correction requested/performed, 70/71 cancellation requested/performed, or 80/81 resend requested/performed.
  • filter[referencedId] — Filter action entries by the ID of the original log entry that triggered them.
  • filter[profileId] — Filter by student profile ID.
  • filter[requestId] — Filter by the ID of the request sent to the health insurance authority.
  • filter[responseId] — Filter by the ID in the response received from the health insurance authority.
  • page[number] — Page number; defaults to 1.
  • page[size] — Page size; defaults to 50.

Output shape

A list of JSON items, typically containing the matching communication log entries.

Results are returned as JSON and paired with their input item. Pagination can be adjusted with page[number] and page[size]. If Continue On Fail is enabled, request errors are returned as an item with an error field.

Links

Discussion