PutSurvey

PUT - /org/project/:projectId/put-survey

Required Permissions:

scope:api

Description

Add a survey to 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
projectId	string	The UUID of the project

Body Parameters

Name	Type	Description
* name	string	The name of the survey.
* code	string	The short-form code for the survey.
* surveyPath	string	The path to the survey metadata file.
consentConfig	object	The configuration of the form with which to ask consent from the subject.
summary	string	The summary for the survey. May contain markdown for styling.

Successful Response

A successful response

Field Name	Type	Description
uuid	uuid	The uuid of the survey.

Code Example

cURL

curl \
  -X PUT "https://rest.eus.canaryspeech.com/v2/org/project/${PROJECT_ID}/put-survey" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
  -d "{ \"name\": \"abc123\", \"code\": \"abc123\", \"surveyPath\": \"abc123\" }"

JavaScript (Fetch)

function putV2OrgProjectPutSurvey() {

  const projectId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/project/${projectId}/put-survey`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { name: 'abc123', code: 'abc123', surveyPath: 'abc123' };
  
  fetch(url, {
    method: 'PUT',
    headers: headers,
    body: JSON.stringify(body)
  }).then((response) => {
    if (!response.ok) throw new Error(response.status);
    return response.json()
  }).then((json) => {
    const { uuid } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function putV2OrgProjectPutSurvey() {

  const projectId = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { name: 'abc123', code: 'abc123', surveyPath: 'abc123' };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/org/project/${projectId}/put-survey`,
    method: 'PUT',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { uuid } = 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 putV2OrgProjectPutSurvey() {

  const projectId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/project/${projectId}/put-survey`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { name: 'abc123', code: 'abc123', surveyPath: 'abc123' };
  
  const response = await axios.put(url, body, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { uuid } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function putV2OrgProjectPutSurvey(): void {

  const projectId = 'abc123';
  
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { name: 'abc123', code: 'abc123', surveyPath: 'abc123' };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: `/v2/org/project/${projectId}/put-survey`,
    method: 'PUT',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { uuid } = 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 putV2OrgProjectPutSurvey(): Promise<void> {

  const projectId = 'abc123';
  
  const url = `https://rest.eus.canaryspeech.com/v2/org/project/${projectId}/put-survey`;
  
  const headers = {
    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  const body = { name: 'abc123', code: 'abc123', surveyPath: 'abc123' };
  
  const response = await axios.put(url, body, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { uuid } = response.data;
  // ...
}

Python (Requests)

import requests

def put_v2_org_project_put_survey():
    project_id = 'abc123'
    
    url = f'https://rest.eus.canaryspeech.com/v2/org/project/{project_id}/put-survey'
    
    headers = {
        'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
    }
    
    body = {
        'name': 'abc123',
        'code': 'abc123',
        'surveyPath': 'abc123'
    }
    
    response = requests.put(
        url,
        headers=headers,
        data=body,
    )
    
    if response.status_code !== 200:
        raise Exception(response.status_code)
    
    response_obj = response.json()
    uuid = response_obj['uuid']
    
    # ...

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 putV2OrgProjectPutSurvey() {
    final String projectId = "abc123"
    
    URI uri = new URI("https://rest.eus.canaryspeech.com/v2/org/project/" + projectId + "/put-survey");
    
    JSONObject body = new JSONObject();
    body.put("name", "abc123");
    body.put("code", "abc123");
    body.put("surveyPath", "abc123");
    
    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")
      .PUT(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 uuid = (String) responseBody.get("uuid");
    
    // ...
  }

}

Kotlin

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

suspend fun putV2OrgProjectPutSurvey() = runCatching {
    val projectId = "abc123"
    
    val url = URL.create("https://rest.eus.canaryspeech.com/v2/org/project/"${projectId}"/put-survey")
    with(url.openConnection() as HttpsURLConnection) {
        requestMethod = "PUT"
        instanceFollowRedirects = true
        
        setRequestProperty("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
        
        doInput = true
        setChunkedStreamingMode(0)
        
        val body = JSONObject()
        body.put("name", String("abc123"))
        body.put("code", String("abc123"))
        body.put("surveyPath", String("abc123"))
        
        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 uuid = responseBody.get("uuid") as String
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func putV2OrgProjectPutSurvey() -> void {
    
    let projectId = "abc123"
    
    let url = URL("https://rest.eus.canaryspeech.com/v2/org/project/\(projectId)/put-survey")
    
    let headers: [String: String] = [
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
    ]
    
    let body: [String: Any] = [ "name": "abc123", "code": "abc123", "surveyPath": "abc123" ]
    
    var request = URLRequest(url: url)
    request.httpMethod = "PUT"
    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(PutV2OrgProjectPutSurveyResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct PutV2OrgProjectPutSurveyResponse: Decodable {
    let uuid: 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 putV2OrgProjectPutSurvey()
    {
        var projectId = "abc123";
        
        var url = "https://rest.eus.canaryspeech.com/v2/org/project/${projectId}/put-survey\"";
        
        var body = new Dictionary<string, dynamic> {
            { "name": "abc123" },
            { "code": "abc123" },
            { "surveyPath": "abc123"
        };
        var bodyString = JsonConvert.Serialize(body);
        
        var request = new HttpRequestMessage(HttpMethod.Put, 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 uuid = (String)responseJson["uuid"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

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

Future<void> function putV2OrgProjectPutSurvey() async {
  final projectId = 'abc123';
  
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v2/org/project/$projectId/put-survey', queryParams);
  
  final headers = {
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
  };
  
  final body =  { 'name': 'abc123', 'code': 'abc123', 'surveyPath': 'abc123' };
  
  final request = http.Request('PUT', 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 uuid = response['uuid'] as String;
    
    // ...
  } catch (e) {
    print(e);
  }
}