PatchAssessment

PATCH - /org/assessment/:assessmentId

Required Permissions:

scope:api

Description

Patch an assessment

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
assessmentId	string	The UUID of the assessment

Body Parameters

Name	Type	Description
* isComplete	boolean	Whether the assessment is marked as complete.
extraData	object	Any additional optional metadata of the assessment.

Successful Response

A successful response

Field Name	Type	Description
message	string	"OK"

Code Example

cURL

curl \
  -X PATCH "https://rest.eus.canaryspeech.com/v2/org/assessment/${ASSESSMENT_ID}" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
  -d "{ \"isComplete\": true }"

JavaScript (Fetch)

function patchV2OrgAssessment() {

  const assessmentId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/assessment/${assessmentId}`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { isComplete: true };
  
  fetch(url, {
    method: 'PATCH',
    headers: headers,
    body: JSON.stringify(body)
  }).then((response) => {
    if (!response.ok) throw new Error(response.status);
    return response.json()
  }).then((json) => {
    const { message } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function patchV2OrgAssessment() {

  const assessmentId = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { isComplete: true };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/org/assessment/${assessmentId}`,
    method: 'PATCH',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { message } = JSON.parse(d);
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.write(JSON.stringify(body));
  request.end();
  
}

JavaScript (Axios)

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

async function patchV2OrgAssessment() {

  const assessmentId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/assessment/${assessmentId}`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { isComplete: true };
  
  const response = await axios.patch(url, body, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { message } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function patchV2OrgAssessment(): void {

  const assessmentId = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { isComplete: true };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/org/assessment/${assessmentId}`,
    method: 'PATCH',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { message } = JSON.parse(d) as Record<string, unknown>;
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.write(JSON.stringify(body));
  request.end();
}

TypeScript (Axios)

import axios from 'axios';

async function patchV2OrgAssessment(): Promise<void> {

  const assessmentId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/assessment/${assessmentId}`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { isComplete: true };
  
  const response = await axios.patch(url, body, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { message } = response.data;
  // ...
}

Python (Requests)

import requests

def patch_v2_org_assessment():
    assessment_id = 'abc123'
    
    url = f'https://rest.eus.canaryspeech.com/v2/org/assessment/{assessment_id}'
    
    headers = {
        'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
    }
    
    body = {
        'isComplete': True
    }
    
    response = requests.patch(
        url,
        headers=headers,
        data=body,
    )
    
    if response.status_code !== 200:
        raise Exception(response.status_code)
    
    response_obj = response.json()
    message = response_obj['message']
    
    # ...

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 patchV2OrgAssessment() {
    final String assessmentId = "abc123"
    
    URI uri = new URI("https://rest.eus.canaryspeech.com/v2/org/assessment/" + assessmentId);
    
    JSONObject body = new JSONObject();
    body.put("isComplete", new Boolean(true));
    
    byte[] bodyBytes = JSONValue.toJSONString(body).getBytes(StandardCharsets.UTF_8);
    
    HttpRequest request = HttpRequest.newBuilder()
      .uri(uri)
      .version(HttpClient.Version.HTTP_2)
      .header("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
      .PATCH(BodyPublishers.ofByteArray(bodyBytes))
      .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 message = (String) responseBody.get("message");
    
    // ...
  }

}

Kotlin

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

suspend fun patchV2OrgAssessment() = runCatching {
    val assessmentId = "abc123"
    
    val url = URL.create("https://rest.eus.canaryspeech.com/v2/org/assessment/"${assessmentId}"")
    with(url.openConnection() as HttpsURLConnection) {
        requestMethod = "PATCH"
        instanceFollowRedirects = true
        
        setRequestProperty("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
        
        doInput = true
        setChunkedStreamingMode(0)
        
        val body = JSONObject()
        body.put("isComplete", Boolean(true))
        
        outputStream.bufferedWriter(Charsets.UTF_8).use {
            it.write(body.toString())
            it.flush()
        }
        
        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 message = responseBody.get("message") as String
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func patchV2OrgAssessment() -> void {
    
    let assessmentId = "abc123"
    
    let url = URL("https://rest.eus.canaryspeech.com/v2/org/assessment/\(assessmentId)")
    
    let headers: [String: String] = [
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    ]
    
    let body: [String: Any] = [ "isComplete": true ]
    
    var request = URLRequest(url: url)
    request.httpMethod = "PATCH"
    request.allHTTPHeaderFields = headers
    request.httpBody = JSONEncoder().encode(body)
    
    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(PatchV2OrgAssessmentResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct PatchV2OrgAssessmentResponse: Decodable {
    let message: 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 patchV2OrgAssessment()
    {
        var assessmentId = "abc123";
        
        var url = "https://rest.eus.canaryspeech.com/v2/org/assessment/${assessmentId}\"";
        
        var body = new Dictionary<string, dynamic> { { "isComplete": true };
        var bodyString = JsonConvert.Serialize(body);
        
        var request = new HttpRequestMessage(HttpMethod.Patch, url);
        request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c");
        request.Content = new ByteArrayContent(Encoding.UTF8.GetBytes(bodyString));
        
        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();
        
        var responseBody = await response.Content.ReadAsStringAsync();
        var responseJson = JsonConvert.DeserializeObject<Dictionary<string, dynamic>>(responseBody);
        var message = (String)responseJson["message"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

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

Future<void> function patchV2OrgAssessment() async {
  final assessmentId = 'abc123';
  
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v2/org/assessment/$assessmentId', queryParams);
  
  final headers = {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  final body =  { 'isComplete': true };
  
  final request = http.Request('PATCH', uri);
  request.headers.addAll(headers)
  request.body = json.encode(body);
  
  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 message = response['message'] as String;
    
    // ...
  } catch (e) {
    print(e);
  }
}