Crowdemotion-api-client-js NPM

crowdemotion-api-client-js

CrowdemotionApiClientJs - JavaScript client for crowdemotion-api-client-js CrowdEmotion API This SDK is automatically generated by the Swagger Codegen project:

API version: 1.1.0
Package version: 1.1.0
Build date: 2016-08-11T15:53:22.718+01:00
Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install crowdemotion-api-client-js --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

var CrowdemotionApiClientJs = require('crowdemotion-api-client-js');

var defaultClient = CrowdemotionApiClientJs.ApiClient.default;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new CrowdemotionApiClientJs.FaceVideoApi()

var facevideoId = 56; // {Integer} ID of FaceVideo to be deleted.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.facevideoFacevideoIdDelete(facevideoId, callback);

Documentation for API Endpoints

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

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

Documentation for Models

Documentation for Authorization

api_key

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

superagent

@everything-registry/sub-chunk-1415 @zalastax/nolb-crow

1.1.0

6 years ago