Skip to content

Latest commit

 

History

History
296 lines (217 loc) · 9 KB

ResearchApi.md

File metadata and controls

296 lines (217 loc) · 9 KB
Raw

ResearchApi

All URIs are relative to https://api.crowdemotion.co.uk/v1

Method HTTP request Description
researchGet GET /research Find all Research
researchPost POST /research Create a Research Project
researchResearchIdDelete DELETE /research/{research_id} Delete Research Project
researchResearchIdGet GET /research/{research_id} Find a Research Project
researchResearchIdPut PUT /research/{research_id} Edit Research Project details

researchGet

List<Research> researchGet(skip, limit, where, sort)

Find all Research

<p>Returns all the Research created by an admin user.</p> <p><strong>Permissions:</strong> ✓ Respondent ✗ Customer ✓ Manager</p>

Example

// Import classes:
//import co.uk.crowdemotion.ApiClient;
//import co.uk.crowdemotion.ApiException;
//import co.uk.crowdemotion.Configuration;
//import co.uk.crowdemotion.auth.*;
//import co.uk.crowdemotion.ResearchApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

ResearchApi apiInstance = new ResearchApi();
Integer skip = 56; // Integer | The number of results to skip.
Integer limit = 56; // Integer | The maximum number of results to return.
String where = "where_example"; // String | JSON formatted string condition.
String sort = "sort_example"; // String | Attribute used to sort results.
try {
    List<Research> result = apiInstance.researchGet(skip, limit, where, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResearchApi#researchGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
skip Integer The number of results to skip. [optional]
limit Integer The maximum number of results to return. [optional]
where String JSON formatted string condition. [optional]
sort String Attribute used to sort results. [optional]

Return type

List<Research>

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

researchPost

Research researchPost(body)

Create a Research Project

<p>New research projects can only be created with an admin account.</p> <p><strong>Permissions:</strong> ✗ Respondent ✗ Customer ✓ Manager</p>

Example

// Import classes:
//import co.uk.crowdemotion.ApiClient;
//import co.uk.crowdemotion.ApiException;
//import co.uk.crowdemotion.Configuration;
//import co.uk.crowdemotion.auth.*;
//import co.uk.crowdemotion.ResearchApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

ResearchApi apiInstance = new ResearchApi();
ResearchCreation body = new ResearchCreation(); // ResearchCreation | Request body
try {
    Research result = apiInstance.researchPost(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResearchApi#researchPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ResearchCreation Request body

Return type

Research

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

researchResearchIdDelete

String researchResearchIdDelete(researchId)

Delete Research Project

<p><strong>Permissions:</strong> ✗ Respondent ✗ Customer ✓ Manager</p>

Example

// Import classes:
//import co.uk.crowdemotion.ApiClient;
//import co.uk.crowdemotion.ApiException;
//import co.uk.crowdemotion.Configuration;
//import co.uk.crowdemotion.auth.*;
//import co.uk.crowdemotion.ResearchApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

ResearchApi apiInstance = new ResearchApi();
Integer researchId = 56; // Integer | 
try {
    String result = apiInstance.researchResearchIdDelete(researchId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResearchApi#researchResearchIdDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
researchId Integer

Return type

String

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

researchResearchIdGet

Research researchResearchIdGet(researchId)

Find a Research Project

<p><strong>Permissions:</strong> ✗ Respondent ✗ Customer ✓ Manager</p>

Example

// Import classes:
//import co.uk.crowdemotion.ApiClient;
//import co.uk.crowdemotion.ApiException;
//import co.uk.crowdemotion.Configuration;
//import co.uk.crowdemotion.auth.*;
//import co.uk.crowdemotion.ResearchApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

ResearchApi apiInstance = new ResearchApi();
Integer researchId = 56; // Integer | ID of Research Project to be found.
try {
    Research result = apiInstance.researchResearchIdGet(researchId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResearchApi#researchResearchIdGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
researchId Integer ID of Research Project to be found.

Return type

Research

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

researchResearchIdPut

Research researchResearchIdPut(researchId, body)

Edit Research Project details

<p><strong>Permissions:</strong> ✗ Respondent ✗ Customer ✓ Manager</p>

Example

// Import classes:
//import co.uk.crowdemotion.ApiClient;
//import co.uk.crowdemotion.ApiException;
//import co.uk.crowdemotion.Configuration;
//import co.uk.crowdemotion.auth.*;
//import co.uk.crowdemotion.ResearchApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

ResearchApi apiInstance = new ResearchApi();
Integer researchId = 56; // Integer | 
ResearchCreation body = new ResearchCreation(); // ResearchCreation | Request body
try {
    Research result = apiInstance.researchResearchIdPut(researchId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ResearchApi#researchResearchIdPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
researchId Integer
body ResearchCreation Request body

Return type

Research

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json