curl --request GET \
--url https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined \
--header 'x-api-key: <api-key>'import requests
url = "https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"meta": {},
"data": {
"id": "<string>",
"externalId": "<string>",
"status": "queued",
"caseNumber": 123,
"targetInstitute": {
"id": "<string>",
"name": "<string>"
},
"candidate": {
"fullName": "<string>",
"dateOfBirth": "<string>"
},
"combinedEquivalencies": [
{
"equivalency": "<string>",
"credentialIds": [
"<string>"
]
}
],
"credentials": [
{
"credentialId": "<string>",
"uploadId": "<string>",
"institution": {
"name": "<string>",
"country": "<string>"
},
"qualification": {
"name": "<string>",
"educationLevel": "<string>",
"program": "<string>",
"programDurationYears": 123,
"yearOfAdmission": 123,
"yearsOfAttendance": [
123
],
"dateOfAward": "<string>"
},
"evaluations": [
{
"evaluationId": "<string>",
"status": "queued",
"completedAt": null,
"targetInstitute": {
"id": "<string>",
"name": "<string>"
}
}
]
}
],
"pendingCredentialIds": [
"<string>"
]
}
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Get combined equivalency as JSON
Returns the combined equivalency for one target institute, together with the credentials it was built from. Courses are omitted; use GET /cases//evaluation when you need them.
Unlike the combined report routes this never returns 409. An unready target answers 200 with status queued, processing, or failed and the pending credential IDs, so this is the endpoint to poll before downloading a report. Reading it never triggers combined equivalency generation, so polling it is free of side effects.
curl --request GET \
--url https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined \
--header 'x-api-key: <api-key>'import requests
url = "https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eval-api.trential.dev/partner/v1/cases/{id}/evaluation/combined")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"meta": {},
"data": {
"id": "<string>",
"externalId": "<string>",
"status": "queued",
"caseNumber": 123,
"targetInstitute": {
"id": "<string>",
"name": "<string>"
},
"candidate": {
"fullName": "<string>",
"dateOfBirth": "<string>"
},
"combinedEquivalencies": [
{
"equivalency": "<string>",
"credentialIds": [
"<string>"
]
}
],
"credentials": [
{
"credentialId": "<string>",
"uploadId": "<string>",
"institution": {
"name": "<string>",
"country": "<string>"
},
"qualification": {
"name": "<string>",
"educationLevel": "<string>",
"program": "<string>",
"programDurationYears": 123,
"yearOfAdmission": 123,
"yearsOfAttendance": [
123
],
"dateOfAward": "<string>"
},
"evaluations": [
{
"evaluationId": "<string>",
"status": "queued",
"completedAt": null,
"targetInstitute": {
"id": "<string>",
"name": "<string>"
}
}
]
}
],
"pendingCredentialIds": [
"<string>"
]
}
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Authorizations
Partner API key. Also accepted as Authorization: Bearer <key>.
Path Parameters
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
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.
true
Optional metadata (e.g. pagination). Empty object when not applicable.
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.
Show child attributes
Show child attributes