Get crosswalk records

get

https://s3partnerapi-staging.solutran.com/2.2/crosswalkrecords

Retrieves a collection of crosswalk records based on the specified search criteria and metadata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ProgramId

int64

The program identifier to filter crosswalk records by specific program.

Key

string

The crosswalk key to filter records. Supports comma-separated values for multiple keys.

Year

int32

The year to filter crosswalk records by specific plan year.

DentalPlanStatus

int32

enum

The dental plan status filter to include or exclude records based on plan assignment.
Null value includes all records regardless of dental plan status.

Allowed:

DefaultSort

string

The default sorting criteria for crosswalk record searches, ordered by key.

SearchCriteria

string

Generates a query string representation of the search criteria.
Only includes parameters that have non-null, non-empty, or non-zero 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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content