Get Eligibility Record

get

https://s3partnerapi-staging.solutran.com/2.2/accounts/{acctid}/eligibilityrecords

Retrieves a collection of eligibility records for a given account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

acctid

int64

required

The account ID for which to retrieve eligibility records.

Query Params

AccountId

int64

The account identifier to filter eligibility records by associated account.

ClientAccountId

string

The client-specific account identifier to filter eligibility records.

RecordStatus

string

The record status to filter eligibility records by their current status.

EffectiveDateMin

string

The minimum effective date for filtering eligibility records by effective date range.

EffectiveDateMax

string

The maximum effective date for filtering eligibility records by effective date range.

TerminationDateMin

string

The minimum termination date for filtering eligibility records by termination date range.

TerminationDateMax

string

The maximum termination date for filtering eligibility records by termination date range.

DefaultSort

string

The default sorting criteria for eligibility record searches, ordered by effective date.

SearchCriteria

string

Generates a query string representation of the search criteria.
Only includes parameters that have non-null, non-empty values.

PartnerId

string

Optional partner identifier for the request context.

Include

string

A comma-separated list of related resources to include in the response. Not used for balance inquiry endpoint.

Path

string

The API endpoint path for the current request.
Used internally for request tracking and logging purposes.

TotalCount

int32

The total number of records available for the search criteria.
May be hidden from serialization based on HideTotals setting.

Size

int32

The actual number of records returned in the current response.

Offset

int32

The starting position (zero-based) for the current page of results.

Limit

int32

The maximum number of records to return per page.
Default value is 100 records.

Sort

string

The sorting criteria for the current request.
Used internally for query processing and not included in JSON serialization.

MoreExist

boolean

Indicates whether more results exist beyond the current page.
Automatically calculated based on TotalCount, Limit, and Offset unless explicitly overridden.

HideTotals

boolean

Controls whether total count information should be hidden from the response.
Used internally for performance optimization when total counts are expensive to calculate.

SummaryData

string

Additional summary data that can be included with the response.
Used for aggregated information or custom metadata specific to the search results.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

200OK

400Bad Request