HearMeCheer API

Games

gamesGameIdDelete

deletes a game by id


/games/{gameId}

Usage and SDK Samples

curl -X DELETE -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GamesApi;

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

public class GamesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        GamesApi apiInstance = new GamesApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdDelete(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGameIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GamesApi;

public class GamesApiExample {

    public static void main(String[] args) {
        GamesApi apiInstance = new GamesApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdDelete(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGameIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game

GamesApi *apiInstance = [[GamesApi alloc] init];

// deletes a game by id
[apiInstance gamesGameIdDeleteWith:gameId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.GamesApi()

var gameId = gameId_example; // {String} ID of the Game


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdDelete(gameId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new GamesApi();
            var gameId = gameId_example;  // String | ID of the Game

            try
            {
                // deletes a game by id
                Object result = apiInstance.gamesGameIdDelete(gameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GamesApi.gamesGameIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\GamesApi();
$gameId = gameId_example; // String | ID of the Game

try {
    $result = $api_instance->gamesGameIdDelete($gameId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GamesApi->gamesGameIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GamesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GamesApi->new();
my $gameId = gameId_example; # String | ID of the Game

eval { 
    my $result = $api_instance->gamesGameIdDelete(gameId => $gameId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GamesApi->gamesGameIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GamesApi()
gameId = gameId_example # String | ID of the Game

try: 
    # deletes a game by id
    api_response = api_instance.games_game_id_delete(gameId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GamesApi->gamesGameIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required

Responses

Status: 200 - The resource with that id was deleted successfully

Status: 500 - An error has occurred


gamesGameIdGet

retrieves a game by id


/games/{gameId}

Usage and SDK Samples

curl -X GET -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GamesApi;

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

public class GamesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        GamesApi apiInstance = new GamesApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdGet(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGameIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GamesApi;

public class GamesApiExample {

    public static void main(String[] args) {
        GamesApi apiInstance = new GamesApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdGet(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGameIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game

GamesApi *apiInstance = [[GamesApi alloc] init];

// retrieves a game by id
[apiInstance gamesGameIdGetWith:gameId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.GamesApi()

var gameId = gameId_example; // {String} ID of the Game


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdGet(gameId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new GamesApi();
            var gameId = gameId_example;  // String | ID of the Game

            try
            {
                // retrieves a game by id
                Object result = apiInstance.gamesGameIdGet(gameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GamesApi.gamesGameIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\GamesApi();
$gameId = gameId_example; // String | ID of the Game

try {
    $result = $api_instance->gamesGameIdGet($gameId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GamesApi->gamesGameIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GamesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GamesApi->new();
my $gameId = gameId_example; # String | ID of the Game

eval { 
    my $result = $api_instance->gamesGameIdGet(gameId => $gameId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GamesApi->gamesGameIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GamesApi()
gameId = gameId_example # String | ID of the Game

try: 
    # retrieves a game by id
    api_response = api_instance.games_game_id_get(gameId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GamesApi->gamesGameIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required

Responses

Status: 200 - Returns a single game

Status: 500 - An error has occurred


gamesGameIdPut

updates a game by id


/games/{gameId}

Usage and SDK Samples

curl -X PUT -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GamesApi;

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

public class GamesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        GamesApi apiInstance = new GamesApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdPut(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGameIdPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GamesApi;

public class GamesApiExample {

    public static void main(String[] args) {
        GamesApi apiInstance = new GamesApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdPut(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGameIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game

GamesApi *apiInstance = [[GamesApi alloc] init];

// updates a game by id
[apiInstance gamesGameIdPutWith:gameId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.GamesApi()

var gameId = gameId_example; // {String} ID of the Game


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdPut(gameId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdPutExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new GamesApi();
            var gameId = gameId_example;  // String | ID of the Game

            try
            {
                // updates a game by id
                Object result = apiInstance.gamesGameIdPut(gameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GamesApi.gamesGameIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\GamesApi();
$gameId = gameId_example; // String | ID of the Game

try {
    $result = $api_instance->gamesGameIdPut($gameId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GamesApi->gamesGameIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GamesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GamesApi->new();
my $gameId = gameId_example; # String | ID of the Game

eval { 
    my $result = $api_instance->gamesGameIdPut(gameId => $gameId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GamesApi->gamesGameIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GamesApi()
gameId = gameId_example # String | ID of the Game

try: 
    # updates a game by id
    api_response = api_instance.games_game_id_put(gameId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GamesApi->gamesGameIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required

Responses

Status: 200 - The resource with that id was updated successfully

Status: 500 - An error has occurred


gamesGet

lists all games

Returns a list of games for this company


/games

Usage and SDK Samples

curl -X GET -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GamesApi;

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

public class GamesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        GamesApi apiInstance = new GamesApi();
        try {
            Object result = apiInstance.gamesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GamesApi;

public class GamesApiExample {

    public static void main(String[] args) {
        GamesApi apiInstance = new GamesApi();
        try {
            Object result = apiInstance.gamesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];


GamesApi *apiInstance = [[GamesApi alloc] init];

// lists all games
[apiInstance gamesGetWithCompletionHandler: 
              ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.GamesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new GamesApi();

            try
            {
                // lists all games
                Object result = apiInstance.gamesGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GamesApi.gamesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\GamesApi();

try {
    $result = $api_instance->gamesGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GamesApi->gamesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GamesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GamesApi->new();

eval { 
    my $result = $api_instance->gamesGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GamesApi->gamesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GamesApi()

try: 
    # lists all games
    api_response = api_instance.games_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GamesApi->gamesGet: %s\n" % e)

Parameters

Responses

Status: 200 - Returns a list of games

Status: 500 - An error has occurred


gamesPost

create a game


/games

Usage and SDK Samples

curl -X POST -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GamesApi;

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

public class GamesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        GamesApi apiInstance = new GamesApi();
        Game game = ; // Game | Game to add
        try {
            Object result = apiInstance.gamesPost(game);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GamesApi;

public class GamesApiExample {

    public static void main(String[] args) {
        GamesApi apiInstance = new GamesApi();
        Game game = ; // Game | Game to add
        try {
            Object result = apiInstance.gamesPost(game);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GamesApi#gamesPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

Game *game = ; // Game to add (optional)

GamesApi *apiInstance = [[GamesApi alloc] init];

// create a game
[apiInstance gamesPostWith:game
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.GamesApi()

var opts = { 
  'game':  // {Game} Game to add
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new GamesApi();
            var game = new Game(); // Game | Game to add (optional) 

            try
            {
                // create a game
                Object result = apiInstance.gamesPost(game);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GamesApi.gamesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\GamesApi();
$game = ; // Game | Game to add

try {
    $result = $api_instance->gamesPost($game);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GamesApi->gamesPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GamesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::GamesApi->new();
my $game = WWW::SwaggerClient::Object::Game->new(); # Game | Game to add

eval { 
    my $result = $api_instance->gamesPost(game => $game);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GamesApi->gamesPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GamesApi()
game =  # Game | Game to add (optional)

try: 
    # create a game
    api_response = api_instance.games_post(game=game)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GamesApi->gamesPost: %s\n" % e)

Parameters

Body parameters
Name Description
game

Responses

Status: 200 - The resource created successfully

Status: 500 - An error has occurred


Participants

gamesGameIdParticipantsGet

lists all participants


/games/{gameId}/participants

Usage and SDK Samples

curl -X GET -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}/participants"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParticipantsApi;

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

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdParticipantsGet(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParticipantsApi;

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        try {
            Object result = apiInstance.gamesGameIdParticipantsGet(gameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game

ParticipantsApi *apiInstance = [[ParticipantsApi alloc] init];

// lists all participants
[apiInstance gamesGameIdParticipantsGetWith:gameId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.ParticipantsApi()

var gameId = gameId_example; // {String} ID of the Game


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdParticipantsGet(gameId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdParticipantsGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new ParticipantsApi();
            var gameId = gameId_example;  // String | ID of the Game

            try
            {
                // lists all participants
                Object result = apiInstance.gamesGameIdParticipantsGet(gameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantsApi.gamesGameIdParticipantsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\ParticipantsApi();
$gameId = gameId_example; // String | ID of the Game

try {
    $result = $api_instance->gamesGameIdParticipantsGet($gameId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantsApi->gamesGameIdParticipantsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ParticipantsApi->new();
my $gameId = gameId_example; # String | ID of the Game

eval { 
    my $result = $api_instance->gamesGameIdParticipantsGet(gameId => $gameId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantsApi->gamesGameIdParticipantsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ParticipantsApi()
gameId = gameId_example # String | ID of the Game

try: 
    # lists all participants
    api_response = api_instance.games_game_id_participants_get(gameId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantsApi->gamesGameIdParticipantsGet: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required

Responses

Status: 200 - Returns a list of games

Status: 500 - An error has occurred


gamesGameIdParticipantsParticipantIdDelete

deletes a participant by id


/games/{gameId}/participants/{participantId}

Usage and SDK Samples

curl -X DELETE -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}/participants/{participantId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParticipantsApi;

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

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        String participantId = participantId_example; // String | ID of the Participant
        try {
            Object result = apiInstance.gamesGameIdParticipantsParticipantIdDelete(gameId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsParticipantIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParticipantsApi;

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        String participantId = participantId_example; // String | ID of the Participant
        try {
            Object result = apiInstance.gamesGameIdParticipantsParticipantIdDelete(gameId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsParticipantIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game
String *participantId = participantId_example; // ID of the Participant

ParticipantsApi *apiInstance = [[ParticipantsApi alloc] init];

// deletes a participant by id
[apiInstance gamesGameIdParticipantsParticipantIdDeleteWith:gameId
    participantId:participantId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.ParticipantsApi()

var gameId = gameId_example; // {String} ID of the Game

var participantId = participantId_example; // {String} ID of the Participant


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdParticipantsParticipantIdDelete(gameId, participantId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdParticipantsParticipantIdDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new ParticipantsApi();
            var gameId = gameId_example;  // String | ID of the Game
            var participantId = participantId_example;  // String | ID of the Participant

            try
            {
                // deletes a participant by id
                Object result = apiInstance.gamesGameIdParticipantsParticipantIdDelete(gameId, participantId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantsApi.gamesGameIdParticipantsParticipantIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\ParticipantsApi();
$gameId = gameId_example; // String | ID of the Game
$participantId = participantId_example; // String | ID of the Participant

try {
    $result = $api_instance->gamesGameIdParticipantsParticipantIdDelete($gameId, $participantId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ParticipantsApi->new();
my $gameId = gameId_example; # String | ID of the Game
my $participantId = participantId_example; # String | ID of the Participant

eval { 
    my $result = $api_instance->gamesGameIdParticipantsParticipantIdDelete(gameId => $gameId, participantId => $participantId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ParticipantsApi()
gameId = gameId_example # String | ID of the Game
participantId = participantId_example # String | ID of the Participant

try: 
    # deletes a participant by id
    api_response = api_instance.games_game_id_participants_participant_id_delete(gameId, participantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required
participantId*
String
ID of the Participant
Required

Responses

Status: 200 - The resource with that id was deleted successfully

Status: 500 - An error has occurred


gamesGameIdParticipantsParticipantIdGet

retrieves a participant by id


/games/{gameId}/participants/{participantId}

Usage and SDK Samples

curl -X GET -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}/participants/{participantId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParticipantsApi;

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

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        String participantId = participantId_example; // String | ID of the Participant
        try {
            Object result = apiInstance.gamesGameIdParticipantsParticipantIdGet(gameId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsParticipantIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParticipantsApi;

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        String participantId = participantId_example; // String | ID of the Participant
        try {
            Object result = apiInstance.gamesGameIdParticipantsParticipantIdGet(gameId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsParticipantIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game
String *participantId = participantId_example; // ID of the Participant

ParticipantsApi *apiInstance = [[ParticipantsApi alloc] init];

// retrieves a participant by id
[apiInstance gamesGameIdParticipantsParticipantIdGetWith:gameId
    participantId:participantId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.ParticipantsApi()

var gameId = gameId_example; // {String} ID of the Game

var participantId = participantId_example; // {String} ID of the Participant


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdParticipantsParticipantIdGet(gameId, participantId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdParticipantsParticipantIdGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new ParticipantsApi();
            var gameId = gameId_example;  // String | ID of the Game
            var participantId = participantId_example;  // String | ID of the Participant

            try
            {
                // retrieves a participant by id
                Object result = apiInstance.gamesGameIdParticipantsParticipantIdGet(gameId, participantId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantsApi.gamesGameIdParticipantsParticipantIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\ParticipantsApi();
$gameId = gameId_example; // String | ID of the Game
$participantId = participantId_example; // String | ID of the Participant

try {
    $result = $api_instance->gamesGameIdParticipantsParticipantIdGet($gameId, $participantId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ParticipantsApi->new();
my $gameId = gameId_example; # String | ID of the Game
my $participantId = participantId_example; # String | ID of the Participant

eval { 
    my $result = $api_instance->gamesGameIdParticipantsParticipantIdGet(gameId => $gameId, participantId => $participantId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ParticipantsApi()
gameId = gameId_example # String | ID of the Game
participantId = participantId_example # String | ID of the Participant

try: 
    # retrieves a participant by id
    api_response = api_instance.games_game_id_participants_participant_id_get(gameId, participantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required
participantId*
String
ID of the Participant
Required

Responses

Status: 200 - Returns a single game

Status: 500 - An error has occurred


gamesGameIdParticipantsParticipantIdPut

updates a participant by id


/games/{gameId}/participants/{participantId}

Usage and SDK Samples

curl -X PUT -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}/participants/{participantId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParticipantsApi;

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

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        String participantId = participantId_example; // String | ID of the Participant
        try {
            Object result = apiInstance.gamesGameIdParticipantsParticipantIdPut(gameId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsParticipantIdPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParticipantsApi;

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        String participantId = participantId_example; // String | ID of the Participant
        try {
            Object result = apiInstance.gamesGameIdParticipantsParticipantIdPut(gameId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsParticipantIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game
String *participantId = participantId_example; // ID of the Participant

ParticipantsApi *apiInstance = [[ParticipantsApi alloc] init];

// updates a participant by id
[apiInstance gamesGameIdParticipantsParticipantIdPutWith:gameId
    participantId:participantId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.ParticipantsApi()

var gameId = gameId_example; // {String} ID of the Game

var participantId = participantId_example; // {String} ID of the Participant


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdParticipantsParticipantIdPut(gameId, participantId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdParticipantsParticipantIdPutExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new ParticipantsApi();
            var gameId = gameId_example;  // String | ID of the Game
            var participantId = participantId_example;  // String | ID of the Participant

            try
            {
                // updates a participant by id
                Object result = apiInstance.gamesGameIdParticipantsParticipantIdPut(gameId, participantId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantsApi.gamesGameIdParticipantsParticipantIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\ParticipantsApi();
$gameId = gameId_example; // String | ID of the Game
$participantId = participantId_example; // String | ID of the Participant

try {
    $result = $api_instance->gamesGameIdParticipantsParticipantIdPut($gameId, $participantId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ParticipantsApi->new();
my $gameId = gameId_example; # String | ID of the Game
my $participantId = participantId_example; # String | ID of the Participant

eval { 
    my $result = $api_instance->gamesGameIdParticipantsParticipantIdPut(gameId => $gameId, participantId => $participantId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ParticipantsApi()
gameId = gameId_example # String | ID of the Game
participantId = participantId_example # String | ID of the Participant

try: 
    # updates a participant by id
    api_response = api_instance.games_game_id_participants_participant_id_put(gameId, participantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantsApi->gamesGameIdParticipantsParticipantIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required
participantId*
String
ID of the Participant
Required

Responses

Status: 200 - The resource with that id was updated successfully

Status: 500 - An error has occurred


gamesGameIdParticipantsPost

create a game


/games/{gameId}/participants

Usage and SDK Samples

curl -X POST -H "X-API-Key: [[apiKey]]" -H "X-Company-ID: [[apiKey]]" "https://api.hearmecheer.com/games/{gameId}/participants"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ParticipantsApi;

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

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

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

        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        Participant participant = ; // Participant | Participant to add
        try {
            Object result = apiInstance.gamesGameIdParticipantsPost(gameId, participant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ParticipantsApi;

public class ParticipantsApiExample {

    public static void main(String[] args) {
        ParticipantsApi apiInstance = new ParticipantsApi();
        String gameId = gameId_example; // String | ID of the Game
        Participant participant = ; // Participant | Participant to add
        try {
            Object result = apiInstance.gamesGameIdParticipantsPost(gameId, participant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#gamesGameIdParticipantsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure API key authorization: (authentication scheme: CompanyIdAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Company-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Company-ID"];

String *gameId = gameId_example; // ID of the Game
Participant *participant = ; // Participant to add (optional)

ParticipantsApi *apiInstance = [[ParticipantsApi alloc] init];

// create a game
[apiInstance gamesGameIdParticipantsPostWith:gameId
    participant:participant
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HearMeCheerApi = require('hear_me_cheer_api');
var defaultClient = HearMeCheerApi.ApiClient.instance;

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

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

var api = new HearMeCheerApi.ParticipantsApi()

var gameId = gameId_example; // {String} ID of the Game

var opts = { 
  'participant':  // {Participant} Participant to add
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gamesGameIdParticipantsPost(gameId, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class gamesGameIdParticipantsPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: CompanyIdAuth
            Configuration.Default.ApiKey.Add("X-Company-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Company-ID", "Bearer");

            var apiInstance = new ParticipantsApi();
            var gameId = gameId_example;  // String | ID of the Game
            var participant = new Participant(); // Participant | Participant to add (optional) 

            try
            {
                // create a game
                Object result = apiInstance.gamesGameIdParticipantsPost(gameId, participant);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ParticipantsApi.gamesGameIdParticipantsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\ParticipantsApi();
$gameId = gameId_example; // String | ID of the Game
$participant = ; // Participant | Participant to add

try {
    $result = $api_instance->gamesGameIdParticipantsPost($gameId, $participant);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ParticipantsApi->gamesGameIdParticipantsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ParticipantsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";
# Configure API key authorization: CompanyIdAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Company-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Company-ID'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ParticipantsApi->new();
my $gameId = gameId_example; # String | ID of the Game
my $participant = WWW::SwaggerClient::Object::Participant->new(); # Participant | Participant to add

eval { 
    my $result = $api_instance->gamesGameIdParticipantsPost(gameId => $gameId, participant => $participant);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ParticipantsApi->gamesGameIdParticipantsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# Configure API key authorization: CompanyIdAuth
swagger_client.configuration.api_key['X-Company-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Company-ID'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ParticipantsApi()
gameId = gameId_example # String | ID of the Game
participant =  # Participant | Participant to add (optional)

try: 
    # create a game
    api_response = api_instance.games_game_id_participants_post(gameId, participant=participant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParticipantsApi->gamesGameIdParticipantsPost: %s\n" % e)

Parameters

Path parameters
Name Description
gameId*
String
ID of the Game
Required
Body parameters
Name Description
participant

Responses

Status: 200 - The resource created successfully

Status: 500 - An error has occurred