crowdemotion-api-client-php

CrowdEmotion API

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.1.0
• Build date: 2016-08-11T15:53:25.918+01:00
• Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/crowdemotion-api-client-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\FaceVideoApi();
$facevideo_id = 56; // int | ID of FaceVideo to be deleted.

try {
    $result = $api_instance->facevideoFacevideoIdDelete($facevideo_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FaceVideoApi->facevideoFacevideoIdDelete: ', $e->getMessage(), PHP_EOL;
}

?>

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

• ContentDetails
• Data
• FaceVideo
• FaceVideoUpload
• Login
• LoginResponse
• Media
• MediaCreation
• Metric
• MetricCreation
• Research
• ResearchCreation
• Respondent
• RespondentMetadata
• RespondentMetadataResponse
• Response
• ResponseCreation
• ResponseMetadata
• ResponseMetadataResponse
• Statistics
• Stats
• Status
• Tags
• Timeseries
• User
• UserMetadata
• UserMetadataResponse
• UserUpdateBody
• Videodetails

Documentation For Authorization

api_key

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

Author