Skip to main content
GET
Get combined equivalency as JSON

Authorizations

x-api-key
string
header
required

Partner API key. Also accepted as Authorization: Bearer <key>.

Path Parameters

id
string
required

Identifies the case: its TruEnroll case ID, or the case number (the number shown in TruEnroll and printed on reports). Case numbers are unique across all organizations and lookups are scoped to your own.

Query Parameters

targetInstituteId
string

Target institute ID from an evaluation row's targetInstitute.id. Omit for the general combined equivalency. This is an institute ID, not an evaluation ID.

Response

Combined evaluation retrieved.

success
boolean
required
Example:

true

message
string
required
meta
object
required

Optional metadata (e.g. pagination). Empty object when not applicable.

data
object
required

Combined equivalency for one target, with the credentials it was built from. status is queued before anything is evaluated, processing while the combined equivalency is being produced, and completed when combinedEquivalencies can be read.