GetScore

GET - /org/score/:scoreId

Required Permissions:

scope:api

Description

Get a score by ID

Headers

Header Key	Description	Example
Authorization	The Authorization header for this endpoint. The value must be the token from the /v3/auth/tokens/get endpoint and given using the Bearer pattern.	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW...

Path Parameters

Name	Type	Description
scoreId	string	The uuid of the score

Successful Response

A successful response

Field Name	Type	Description
uuid	uuid	The uuid of the score.
assessmentUUIDs	array<string>	The list of parent assessments associated with this score.
dateRecorded	date-time	The ISO-8601 timestamp of when the child score was recorded.
scoreId	string	The ID of the question as defined in the survey JSON that corresponds to this score.
scoreType	string	The type of the question as defined in the survey JSON.
scoreData	object	The data of the score. If the scoreType starts with "OVERSEER", this object will have a "data" field. Otherwise, it will have a "value" field.
extraData	object	Any additional optional metadata of the child score.

Code Example

cURL

curl \
  -X GET "https://rest.eus.canaryspeech.com/v2/org/score/${SCORE_ID}" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

JavaScript (Fetch)

function getV2OrgScore() {

  const scoreId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/score/${scoreId}`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  fetch(url, {
    method: 'GET',
    headers: headers
  }).then((response) => {
    if (!response.ok) throw new Error(response.status);
    return response.json()
  }).then((json) => {
    const { uuid, assessmentUUIDs, dateRecorded, scoreId, scoreType, scoreData, extraData } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function getV2OrgScore() {

  const scoreId = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/org/score/${scoreId}`,
    method: 'GET',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { uuid, assessmentUUIDs, dateRecorded, scoreId, scoreType, scoreData, extraData } = JSON.parse(d);
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
  
}

JavaScript (Axios)

const axios = require('axios').default;

async function getV2OrgScore() {

  const scoreId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/score/${scoreId}`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const response = await axios.get(url, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { uuid, assessmentUUIDs, dateRecorded, scoreId, scoreType, scoreData, extraData } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function getV2OrgScore(): void {

  const scoreId = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/org/score/${scoreId}`,
    method: 'GET',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { uuid, assessmentUUIDs, dateRecorded, scoreId, scoreType, scoreData, extraData } = JSON.parse(d) as Record<string, unknown>;
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
}

TypeScript (Axios)

import axios from 'axios';

async function getV2OrgScore(): Promise<void> {

  const scoreId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/score/${scoreId}`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const response = await axios.get(url, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { uuid, assessmentUUIDs, dateRecorded, scoreId, scoreType, scoreData, extraData } = response.data;
  // ...
}

Python (Requests)

import requests

def get_v2_org_score():
    score_id = 'abc123'
    
    url = f'https://rest.eus.canaryspeech.com/v2/org/score/{score_id}'
    
    headers = {
        'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
    }
    
    response = requests.get(
        url,
        headers=headers,
    )
    
    if response.status_code !== 200:
        raise Exception(response.status_code)
    
    response_obj = response.json()
    uuid = response_obj['uuid']
    assessment_uUIDs = response_obj['assessmentUUIDs']
    date_recorded = response_obj['dateRecorded']
    score_id = response_obj['scoreId']
    score_type = response_obj['scoreType']
    score_data = response_obj['scoreData']
    extra_data = response_obj['extraData']
    
    # ...

Java

import org.json.simple.JSONObject;
import org.json.simple.JSONArray;
import org.json.simple.JSONParser;
import org.json.simple.JSONValue;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;

public class CanarySpeechApi {

  public void getV2OrgScore() {
    final String scoreId = "abc123"
    
    URI uri = new URI("https://rest.eus.canaryspeech.com/v2/org/score/" + scoreId);
    
    HttpRequest request = HttpRequest.newBuilder()
      .uri(uri)
      .version(HttpClient.Version.HTTP_2)
      .header("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
      .GET()
      .build();
    
    HttpClient client = HttpClient.newBuilder()
      .version(HttpClient.Version.HTTP_1_1)
      .build();
    
    HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
    
    if (client.status != 200) {
      throw new Exception(client.status.toString());
    }
    
    JSONParser parser = new JSONParser();
    JSONObject responseBody = (JSONObject) parser.parse(client.body());
    String uuid = (String) responseBody.get("uuid");
    List<String> assessmentUUIDs = (List<String>) responseBody.get("assessmentUUIDs");
    String dateRecorded = (String) responseBody.get("dateRecorded");
    String scoreId = (String) responseBody.get("scoreId");
    String scoreType = (String) responseBody.get("scoreType");
    Map<String, Object> scoreData = (Map<String, Object>) responseBody.get("scoreData");
    Map<String, Object> extraData = (Map<String, Object>) responseBody.get("extraData");
    
    // ...
  }

}

Kotlin

import org.json.JSONObject
import java.lang.StringBuilder
import java.net.URL
import javax.net.ssl.HttpsURLConnection

suspend fun getV2OrgScore() = runCatching {
    val scoreId = "abc123"
    
    val url = URL.create("https://rest.eus.canaryspeech.com/v2/org/score/"${scoreId}"")
    with(url.openConnection() as HttpsURLConnection) {
        requestMethod = "GET"
        instanceFollowRedirects = true
        
        setRequestProperty("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
        
        doOutput = true
        
        if (responseCode != 200) throw Error(responseMessage)
        
        val buffer = StringBuilder()
        var line: String?
        inputStream.bufferedReader(Charsets.UTF-8).use {
            do {
                line = it.readLine()
                if (line != null) buffer.appendLine(line)
            } while (line != null)
        }
        
        val responseBody = JSONObject(buffer.toString())
        val uuid = responseBody.get("uuid") as String
        val assessmentUUIDs = responseBody.get("assessmentUUIDs") as Array<String>
        val dateRecorded = responseBody.get("dateRecorded") as String
        val scoreId = responseBody.get("scoreId") as String
        val scoreType = responseBody.get("scoreType") as String
        val scoreData = responseBody.get("scoreData") as Map<String, Any?>
        val extraData = responseBody.get("extraData") as Map<String, Any?>
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func getV2OrgScore() -> void {
    
    let scoreId = "abc123"
    
    let url = URL("https://rest.eus.canaryspeech.com/v2/org/score/\(scoreId)")
    
    let headers: [String: String] = [
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    ]
    
    var request = URLRequest(url: url)
    request.httpMethod = "GET"
    request.allHTTPHeaderFields = headers
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        guard
            let data = data,
            let response = response as? HTTPURLResponse,
            error == nil
        else {
            print("error", error ?? URLError(.badServerResponse)
            return
        }
        
        guard (200 ... 299) ~= response.statusCode else {
            print("statusCode = \(response.statusCode)")
            print("response = \(response)")
            return
        }
        
        do {
            let responseObj = try JSONDecoder().decode(GetV2OrgScoreResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct GetV2OrgScoreResponse: Decodable {
    let uuid: String
    let assessmentUUIDs: [String]
    let dateRecorded: String
    let scoreId: String
    let scoreType: String
    let scoreData: [String: Any]
    let extraData: [String: Any]
}

using System.Collections.Generic;
using System.Net.Http;
using System.Text.Encoding;
using System.Text.Json;
using System.Text.Json.Serialization;

public static class CanarySpeechAPI
{
    public static readonly HttpClient client = new HttpClient();
    
    public static async Task getV2OrgScore()
    {
        var scoreId = "abc123";
        
        var url = "https://rest.eus.canaryspeech.com/v2/org/score/${scoreId}\"";
        
        var request = new HttpRequestMessage(HttpMethod.Get, url);
        request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c");
        
        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();
        
        var responseBody = await response.Content.ReadAsStringAsync();
        var responseJson = JsonConvert.DeserializeObject<Dictionary<string, dynamic>>(responseBody);
        var uuid = (String)responseJson["uuid"];
        var assessmentUUIDs = (List<String>)responseJson["assessmentUUIDs"];
        var dateRecorded = (String)responseJson["dateRecorded"];
        var scoreId = (String)responseJson["scoreId"];
        var scoreType = (String)responseJson["scoreType"];
        var scoreData = (Dictionary<String, dynamic>)responseJson["scoreData"];
        var extraData = (Dictionary<String, dynamic>)responseJson["extraData"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

import 'package:http/http.dart' as http;

Future<void> function getV2OrgScore() async {
  final scoreId = 'abc123';
  
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v2/org/score/$scoreId', queryParams);
  
  final headers = {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  final request = http.Request('GET', uri);
  request.headers.addAll(headers)
  
  final client = http.Client();
  try {
    final responseStream = await client.send(request);
    final statusCode = responseStream.statusCode;
    
    if (statusCode < 200 || statusCode >= 300) {
      throw Error(statusCode.toString());
    }
    
    final responseBytes = await responseStream.stream.toBytes();
    final responseString = utf8.decode(responseBytes);
    final response = json.decode(responseString);
    
    final uuid = response['uuid'] as String;
    final assessmentUUIDs = response['assessmentUUIDs'] as List<String>;
    final dateRecorded = response['dateRecorded'] as String;
    final scoreId = response['scoreId'] as String;
    final scoreType = response['scoreType'] as String;
    final scoreData = response['scoreData'] as Map<String, dynamic>;
    final extraData = response['extraData'] as Map<String, dynamic>?;
    
    // ...
  } catch (e) {
    print(e);
  }
}