Client Data API

Default

Client Data API

API for clients to securely provide customer contact and other contextual information, from which we can generate feedback requests.

For example. Information about a recent customer interaction, that may, subject to criteria, be used to trigger a feedback request to that customer.


/client_data/{client_name}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.bigears.com/v1/client_data/{client_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

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

        DefaultApi apiInstance = new DefaultApi();
        String clientName = clientName_example; // String | the client name
        Request_body response = ; // Request_body | 
        try {
            apiInstance.clientDataClientNamePost(clientName, response);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#clientDataClientNamePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String clientName = clientName_example; // String | the client name
        Request_body response = ; // Request_body | 
        try {
            apiInstance.clientDataClientNamePost(clientName, response);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#clientDataClientNamePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *clientName = clientName_example; // the client name
Request_body *response = ; // 

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

// API for clients to securely provide customer contact and other contextual information, from which we can generate feedback requests.
[apiInstance clientDataClientNamePostWith:clientName
    response:response
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ClientDataApi = require('client_data_api');
var defaultClient = ClientDataApi.ApiClient.instance;

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

var api = new ClientDataApi.DefaultApi()

var clientName = clientName_example; // {String} the client name

var response = ; // {Request_body} 


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

namespace Example
{
    public class clientDataClientNamePostExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DefaultApi();
            var clientName = clientName_example;  // String | the client name
            var response = new Request_body(); // Request_body | 

            try
            {
                // API for clients to securely provide customer contact and other contextual information, from which we can generate feedback requests.
                apiInstance.clientDataClientNamePost(clientName, response);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.clientDataClientNamePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\DefaultApi();
$clientName = clientName_example; // String | the client name
$response = ; // Request_body | 

try {
    $api_instance->clientDataClientNamePost($clientName, $response);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->clientDataClientNamePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $clientName = clientName_example; # String | the client name
my $response = WWW::SwaggerClient::Object::Request_body->new(); # Request_body | 

eval { 
    $api_instance->clientDataClientNamePost(clientName => $clientName, response => $response);
};
if ($@) {
    warn "Exception when calling DefaultApi->clientDataClientNamePost: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
clientName = clientName_example # String | the client name
response =  # Request_body | 

try: 
    # API for clients to securely provide customer contact and other contextual information, from which we can generate feedback requests.
    api_instance.client_data_client_name_post(clientName, response)
except ApiException as e:
    print("Exception when calling DefaultApi->clientDataClientNamePost: %s\n" % e)

Parameters

Path parameters
Name Description
client_name*
String
the client name
Required
Body parameters
Name Description
response *

Responses

Status: 200 - OK.

Status: 204 - OK. Record Not Used.

Status: 401 - Access Denied.

Status: 500 - Internal Server Error.


Max time for a response: 100s


Generated 2018-01-10T22:05:03.711Z