crowdemotion-api-client-java

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>co.uk.crowdemotion</groupId>
    <artifactId>crowdemotion-api-client-java</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "co.uk.crowdemotion:crowdemotion-api-client-java:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

target/crowdemotion-api-client-java-1.0.0.jar
target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import co.uk.crowdemotion.*;
import co.uk.crowdemotion.auth.*;
import co.uk.crowdemotion.model.*;
import co.uk.crowdemotion.FaceVideoApi;

import java.io.File;
import java.util.*;

public class FaceVideoApiExample {

    public static void main(String[] args) {
        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");

        FaceVideoApi apiInstance = new FaceVideoApi();
        Integer facevideoId = 56; // Integer | ID of FaceVideo to be deleted.
        try {
            String result = apiInstance.facevideoFacevideoIdDelete(facevideoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FaceVideoApi#facevideoFacevideoIdDelete");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
FaceVideoApi	facevideoFacevideoIdDelete	DELETE /facevideo/{facevideo_id}	Delete a FaceVideo
FaceVideoApi	facevideoGet	GET /facevideo	Find a FaceVideo
FaceVideoApi	facevideoPost	POST /facevideo	Analyse FaceVideo
FaceVideoApi	facevideoPut	PUT /facevideo	Analyse FaceVideo
MediaApi	mediaGet	GET /media	Find all registered Media
MediaApi	mediaMediaIdDelete	DELETE /media/{media_id}	Delete Media
MediaApi	mediaMediaIdGet	GET /media/{media_id}	Find a Media
MediaApi	mediaMediaIdPut	PUT /media/{media_id}	Update a Media
MediaApi	mediaPost	POST /media	Create new Media
MetricApi	metricGet	GET /metric	List all registered metrics
MetricApi	metricMetricIdDelete	DELETE /metric/{metric_id}	Delete a Metric
MetricApi	metricMetricIdGet	GET /metric/{metric_id}	Find a Metric
MetricApi	metricPost	POST /metric	Create Metric
ResearchApi	researchGet	GET /research	Find all Research
ResearchApi	researchPost	POST /research	Create a Research Project
ResearchApi	researchResearchIdDelete	DELETE /research/{research_id}	Delete Research Project
ResearchApi	researchResearchIdGet	GET /research/{research_id}	Find a Research Project
ResearchApi	researchResearchIdPut	PUT /research/{research_id}	Edit Research Project details
RespondentApi	respondentGet	GET /respondent	Find all Respondents of a Research
RespondentApi	respondentPost	POST /respondent	Create a Respondent
RespondentApi	respondentRespondentIdDelete	DELETE /respondent/{respondent_id}	Delete a Respondent
RespondentApi	respondentRespondentIdGet	GET /respondent/{respondent_id}	Find a Respondent
RespondentApi	respondentRespondentIdMetadataGet	GET /respondent/{respondent_id}/metadata	Find Respondent Metadata
RespondentApi	respondentRespondentIdMetadataPost	POST /respondent/{respondent_id}/metadata	Add Respondent Metadata
RespondentApi	respondentRespondentIdPut	PUT /respondent/{respondent_id}	Update a Respondent
ResponseApi	responseGet	GET /response	Find all Responses
ResponseApi	responsePost	POST /response	Create a Response
ResponseApi	responseResponseIdDelete	DELETE /response/{response_id}	Delete a Response
ResponseApi	responseResponseIdGet	GET /response/{response_id}	Find a Response
ResponseApi	responseResponseIdMetadataGet	GET /response/{response_id}/metadata	Show Response Metadata
ResponseApi	responseResponseIdMetadataPost	POST /response/{response_id}/metadata	Add Response Metadata
ResponseApi	responseResponseIdPut	PUT /response/{response_id}	Update a Response
TimeseriesApi	timeseriesDelete	DELETE /timeseries	Delete a Timeseries
TimeseriesApi	timeseriesGet	GET /timeseries	Get all recorded timeseries for a Response
UserApi	userIdGet	GET /user/{id}	Get User information
UserApi	userIdPut	PUT /user/{id}	Edit User information
UserApi	userLoginPost	POST /user/login	User Login
UserApi	userUserIdMetadataGet	GET /user/{user_id}/metadata	Find User metadata
UserApi	userUserIdMetadataPost	POST /user/{user_id}/metadata	Add user metadata

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

Type: API key
API key parameter name: Authorization
Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.

crowdemotion / crowdemotion-api-client-java Goto Github PK