GetProjectAppData

GET - /meta/get-project-data/:projectCode

Required Permissions:

scope:app

Description

Gets the application data for a project.

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
projectCode	string	The code of the project.

Successful Response

A successful response

Field Name	Type	Description
projectCode	string	The code of the project.
projectId	uuid	The ID of the project.
surveyTitleLang	object	A mapping of language codes to survey names so as to localize survey names.
projectApiUrl	string	The URL of the server where the API for this project is hosted.
branding	object	The theme rules for customizing the branding of the app after logging into this project.
loginStrategy	object	The strategy for how subjects in this project are meant to log in and take assessments.
assessmentStrategy	object	The strategy for how assessments in this project are to be handled.
profileStrategy	object	The strategy for how the subject's profile screen is managed.
testSubjects	array<string>	A list of regex-based subject names to recognize as test data and exclude from reports, etc.

Code Example

cURL

curl \
  -X GET "https://rest.eus.canaryspeech.com/v2/meta/get-project-data/${PROJECT_CODE}" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

JavaScript (Fetch)

function getV2MetaGetProjectData() {

  const projectCode = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/meta/get-project-data/${projectCode}`;
  
  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 { projectCode, projectId, surveyTitleLang, projectApiUrl, branding, loginStrategy, assessmentStrategy, profileStrategy, testSubjects } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function getV2MetaGetProjectData() {

  const projectCode = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/meta/get-project-data/${projectCode}`,
    method: 'GET',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { projectCode, projectId, surveyTitleLang, projectApiUrl, branding, loginStrategy, assessmentStrategy, profileStrategy, testSubjects } = JSON.parse(d);
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
  
}

JavaScript (Axios)

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

async function getV2MetaGetProjectData() {

  const projectCode = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/meta/get-project-data/${projectCode}`;
  
  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 { projectCode, projectId, surveyTitleLang, projectApiUrl, branding, loginStrategy, assessmentStrategy, profileStrategy, testSubjects } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function getV2MetaGetProjectData(): void {

  const projectCode = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/meta/get-project-data/${projectCode}`,
    method: 'GET',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { projectCode, projectId, surveyTitleLang, projectApiUrl, branding, loginStrategy, assessmentStrategy, profileStrategy, testSubjects } = 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 getV2MetaGetProjectData(): Promise<void> {

  const projectCode = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/meta/get-project-data/${projectCode}`;
  
  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 { projectCode, projectId, surveyTitleLang, projectApiUrl, branding, loginStrategy, assessmentStrategy, profileStrategy, testSubjects } = response.data;
  // ...
}

Python (Requests)

import requests

def get_v2_meta_get_project_data():
    project_code = 'abc123'
    
    url = f'https://rest.eus.canaryspeech.com/v2/meta/get-project-data/{project_code}'
    
    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()
    project_code = response_obj['projectCode']
    project_id = response_obj['projectId']
    survey_title_lang = response_obj['surveyTitleLang']
    project_api_url = response_obj['projectApiUrl']
    branding = response_obj['branding']
    login_strategy = response_obj['loginStrategy']
    assessment_strategy = response_obj['assessmentStrategy']
    profile_strategy = response_obj['profileStrategy']
    test_subjects = response_obj['testSubjects']
    
    # ...

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 getV2MetaGetProjectData() {
    final String projectCode = "abc123"
    
    URI uri = new URI("https://rest.eus.canaryspeech.com/v2/meta/get-project-data/" + projectCode);
    
    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 projectCode = (String) responseBody.get("projectCode");
    String projectId = (String) responseBody.get("projectId");
    Map<String, Object> surveyTitleLang = (Map<String, Object>) responseBody.get("surveyTitleLang");
    String projectApiUrl = (String) responseBody.get("projectApiUrl");
    Map<String, Object> branding = (Map<String, Object>) responseBody.get("branding");
    Map<String, Object> loginStrategy = (Map<String, Object>) responseBody.get("loginStrategy");
    Map<String, Object> assessmentStrategy = (Map<String, Object>) responseBody.get("assessmentStrategy");
    Map<String, Object> profileStrategy = (Map<String, Object>) responseBody.get("profileStrategy");
    List<String> testSubjects = (List<String>) responseBody.get("testSubjects");
    
    // ...
  }

}

Kotlin

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

suspend fun getV2MetaGetProjectData() = runCatching {
    val projectCode = "abc123"
    
    val url = URL.create("https://rest.eus.canaryspeech.com/v2/meta/get-project-data/"${projectCode}"")
    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 projectCode = responseBody.get("projectCode") as String
        val projectId = responseBody.get("projectId") as String
        val surveyTitleLang = responseBody.get("surveyTitleLang") as Map<String, Any?>
        val projectApiUrl = responseBody.get("projectApiUrl") as String
        val branding = responseBody.get("branding") as Map<String, Any?>
        val loginStrategy = responseBody.get("loginStrategy") as Map<String, Any?>
        val assessmentStrategy = responseBody.get("assessmentStrategy") as Map<String, Any?>
        val profileStrategy = responseBody.get("profileStrategy") as Map<String, Any?>
        val testSubjects = responseBody.get("testSubjects") as Array<String>
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func getV2MetaGetProjectData() -> void {
    
    let projectCode = "abc123"
    
    let url = URL("https://rest.eus.canaryspeech.com/v2/meta/get-project-data/\(projectCode)")
    
    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(GetV2MetaGetProjectDataResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct GetV2MetaGetProjectDataResponse: Decodable {
    let projectCode: String
    let projectId: String
    let surveyTitleLang: [String: Any]
    let projectApiUrl: String
    let branding: [String: Any]
    let loginStrategy: [String: Any]
    let assessmentStrategy: [String: Any]
    let profileStrategy: [String: Any]
    let testSubjects: [String]
}

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 getV2MetaGetProjectData()
    {
        var projectCode = "abc123";
        
        var url = "https://rest.eus.canaryspeech.com/v2/meta/get-project-data/${projectCode}\"";
        
        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 projectCode = (String)responseJson["projectCode"];
        var projectId = (String)responseJson["projectId"];
        var surveyTitleLang = (Dictionary<String, dynamic>)responseJson["surveyTitleLang"];
        var projectApiUrl = (String)responseJson["projectApiUrl"];
        var branding = (Dictionary<String, dynamic>)responseJson["branding"];
        var loginStrategy = (Dictionary<String, dynamic>)responseJson["loginStrategy"];
        var assessmentStrategy = (Dictionary<String, dynamic>)responseJson["assessmentStrategy"];
        var profileStrategy = (Dictionary<String, dynamic>)responseJson["profileStrategy"];
        var testSubjects = (List<String>)responseJson["testSubjects"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

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

Future<void> function getV2MetaGetProjectData() async {
  final projectCode = 'abc123';
  
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v2/meta/get-project-data/$projectCode', 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 projectCode = response['projectCode'] as String;
    final projectId = response['projectId'] as String;
    final surveyTitleLang = response['surveyTitleLang'] as Map<String, dynamic>;
    final projectApiUrl = response['projectApiUrl'] as String;
    final branding = response['branding'] as Map<String, dynamic>?;
    final loginStrategy = response['loginStrategy'] as Map<String, dynamic>;
    final assessmentStrategy = response['assessmentStrategy'] as Map<String, dynamic>;
    final profileStrategy = response['profileStrategy'] as Map<String, dynamic>;
    final testSubjects = response['testSubjects'] as List<String>;
    
    // ...
  } catch (e) {
    print(e);
  }
}