directable API

Api

apiReportsCreate


/api/reports/

Usage and SDK Samples

curl -X POST\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/reports/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Report body = ; // Report | 
        try {
            Report result = apiInstance.apiReportsCreate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Report body = ; // Report | 
        try {
            Report result = apiInstance.apiReportsCreate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Report *body = ; // 

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

[apiInstance apiReportsCreateWith:body
              completionHandler: ^(Report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var body = ; // {{Report}} 

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

namespace Example
{
    public class apiReportsCreateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var body = new Report(); // Report | 

            try
            {
                Report result = apiInstance.apiReportsCreate(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiReportsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$body = ; // Report | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $body = WWW::SwaggerClient::Object::Report->new(); # Report | 

eval { 
    my $result = $api_instance->apiReportsCreate(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiReportsCreate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
body =  # Report | 

try: 
    api_response = api_instance.api_reports_create(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiReportsCreate: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Form parameters
Name Description
id*
Integer
Required
politician*
String
Required
congress_body*
CongressBodyEnum
Required
filing_format*
FilingFormatEnum
Required
public_url*
String (uri)
Required
archive*
String (uri)
Required
ingested_datetime*
Date (date-time)
Required
needs_qa*
Boolean
Required
content_hash*
String
Required
parent*
Integer
Required
id*
Integer
Required
politician*
String
Required
congress_body*
CongressBodyEnum
Required
filing_format*
FilingFormatEnum
Required
public_url*
String (uri)
Required
archive*
String (uri)
Required
ingested_datetime*
Date (date-time)
Required
needs_qa*
Boolean
Required
content_hash*
String
Required
parent*
Integer
Required
Query parameters
Name Description

Responses

Status: 201 -


apiReportsDestroy


/api/reports/{id}/

Usage and SDK Samples

curl -X DELETE\
\
-H "Authorization: [[apiKey]]"\
"http://127.0.0.1:8000/api/reports/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this report.
        try {
            apiInstance.apiReportsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsDestroy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this report.
        try {
            apiInstance.apiReportsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *id = 56; // A unique integer value identifying this report.

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

[apiInstance apiReportsDestroyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var id = 56; // {{Integer}} A unique integer value identifying this report.

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

namespace Example
{
    public class apiReportsDestroyExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this report.

            try
            {
                apiInstance.apiReportsDestroy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiReportsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$id = 56; // Integer | A unique integer value identifying this report.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this report.

eval { 
    $api_instance->apiReportsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling ApiApi->apiReportsDestroy: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
id = 56 # Integer | A unique integer value identifying this report.

try: 
    api_instance.api_reports_destroy(id)
except ApiException as e:
    print("Exception when calling ApiApi->apiReportsDestroy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this report.
Required
Query parameters
Name Description

Responses

Status: 204 - No response body


apiReportsList


/api/reports/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/reports/?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        try {
            PaginatedReportList result = apiInstance.apiReportsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        try {
            PaginatedReportList result = apiInstance.apiReportsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *limit = 56; // Number of results to return per page. (optional)
Integer *offset = 56; // The initial index from which to return the results. (optional)

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

[apiInstance apiReportsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedReportList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var opts = { 
  'limit': 56, // {{Integer}} Number of results to return per page.
  'offset': 56 // {{Integer}} The initial index from which to return the results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiReportsList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiReportsListExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional) 
            var offset = 56;  // Integer | The initial index from which to return the results. (optional) 

            try
            {
                PaginatedReportList result = apiInstance.apiReportsList(limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiReportsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval { 
    my $result = $api_instance->apiReportsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiReportsList: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
limit = 56 # Integer | Number of results to return per page. (optional)
offset = 56 # Integer | The initial index from which to return the results. (optional)

try: 
    api_response = api_instance.api_reports_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiReportsList: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses

Status: 200 -


apiReportsPartialUpdate


/api/reports/{id}/

Usage and SDK Samples

curl -X PATCH\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/reports/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this report.
        PatchedReport body = ; // PatchedReport | 
        try {
            Report result = apiInstance.apiReportsPartialUpdate(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsPartialUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this report.
        PatchedReport body = ; // PatchedReport | 
        try {
            Report result = apiInstance.apiReportsPartialUpdate(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsPartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *id = 56; // A unique integer value identifying this report.
PatchedReport *body = ; //  (optional)

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

[apiInstance apiReportsPartialUpdateWith:id
    body:body
              completionHandler: ^(Report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var id = 56; // {{Integer}} A unique integer value identifying this report.
var opts = { 
  'body':  // {{PatchedReport}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiReportsPartialUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiReportsPartialUpdateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this report.
            var body = new PatchedReport(); // PatchedReport |  (optional) 

            try
            {
                Report result = apiInstance.apiReportsPartialUpdate(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiReportsPartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$id = 56; // Integer | A unique integer value identifying this report.
$body = ; // PatchedReport | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this report.
my $body = WWW::SwaggerClient::Object::PatchedReport->new(); # PatchedReport | 

eval { 
    my $result = $api_instance->apiReportsPartialUpdate(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiReportsPartialUpdate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
id = 56 # Integer | A unique integer value identifying this report.
body =  # PatchedReport |  (optional)

try: 
    api_response = api_instance.api_reports_partial_update(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiReportsPartialUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this report.
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
politician
String
congress_body
CongressBodyEnum
filing_format
FilingFormatEnum
public_url
String (uri)
archive
String (uri)
ingested_datetime
Date (date-time)
needs_qa
Boolean
content_hash
String
parent
Integer
id
Integer
politician
String
congress_body
CongressBodyEnum
filing_format
FilingFormatEnum
public_url
String (uri)
archive
String (uri)
ingested_datetime
Date (date-time)
needs_qa
Boolean
content_hash
String
parent
Integer
Query parameters
Name Description

Responses

Status: 200 -


apiReportsRetrieve


/api/reports/{id}/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/reports/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this report.
        try {
            Report result = apiInstance.apiReportsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsRetrieve");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this report.
        try {
            Report result = apiInstance.apiReportsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *id = 56; // A unique integer value identifying this report.

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

[apiInstance apiReportsRetrieveWith:id
              completionHandler: ^(Report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var id = 56; // {{Integer}} A unique integer value identifying this report.

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

namespace Example
{
    public class apiReportsRetrieveExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this report.

            try
            {
                Report result = apiInstance.apiReportsRetrieve(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiReportsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$id = 56; // Integer | A unique integer value identifying this report.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this report.

eval { 
    my $result = $api_instance->apiReportsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiReportsRetrieve: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
id = 56 # Integer | A unique integer value identifying this report.

try: 
    api_response = api_instance.api_reports_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiReportsRetrieve: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this report.
Required
Query parameters
Name Description

Responses

Status: 200 -


apiReportsUpdate


/api/reports/{id}/

Usage and SDK Samples

curl -X PUT\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/reports/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Report body = ; // Report | 
        Integer id = 56; // Integer | A unique integer value identifying this report.
        try {
            Report result = apiInstance.apiReportsUpdate(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Report body = ; // Report | 
        Integer id = 56; // Integer | A unique integer value identifying this report.
        try {
            Report result = apiInstance.apiReportsUpdate(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiReportsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Report *body = ; // 
Integer *id = 56; // A unique integer value identifying this report.

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

[apiInstance apiReportsUpdateWith:body
    id:id
              completionHandler: ^(Report output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var body = ; // {{Report}} 
var id = 56; // {{Integer}} A unique integer value identifying this report.

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

namespace Example
{
    public class apiReportsUpdateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var body = new Report(); // Report | 
            var id = 56;  // Integer | A unique integer value identifying this report.

            try
            {
                Report result = apiInstance.apiReportsUpdate(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiReportsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$body = ; // Report | 
$id = 56; // Integer | A unique integer value identifying this report.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $body = WWW::SwaggerClient::Object::Report->new(); # Report | 
my $id = 56; # Integer | A unique integer value identifying this report.

eval { 
    my $result = $api_instance->apiReportsUpdate(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiReportsUpdate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
body =  # Report | 
id = 56 # Integer | A unique integer value identifying this report.

try: 
    api_response = api_instance.api_reports_update(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiReportsUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this report.
Required
Body parameters
Name Description
body *
Form parameters
Name Description
id*
Integer
Required
politician*
String
Required
congress_body*
CongressBodyEnum
Required
filing_format*
FilingFormatEnum
Required
public_url*
String (uri)
Required
archive*
String (uri)
Required
ingested_datetime*
Date (date-time)
Required
needs_qa*
Boolean
Required
content_hash*
String
Required
parent*
Integer
Required
id*
Integer
Required
politician*
String
Required
congress_body*
CongressBodyEnum
Required
filing_format*
FilingFormatEnum
Required
public_url*
String (uri)
Required
archive*
String (uri)
Required
ingested_datetime*
Date (date-time)
Required
needs_qa*
Boolean
Required
content_hash*
String
Required
parent*
Integer
Required
Query parameters
Name Description

Responses

Status: 200 -


apiSchemaRetrieve

OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json


/api/schema/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/vnd.oai.openapi,application/yaml,application/vnd.oai.openapi+json,application/json"\
"http://127.0.0.1:8000/api/schema/?format=&lang="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        String format = format_example; // String | 
        String lang = lang_example; // String | 
        try {
            map['String', null] result = apiInstance.apiSchemaRetrieve(format, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiSchemaRetrieve");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String format = format_example; // String | 
        String lang = lang_example; // String | 
        try {
            map['String', null] result = apiInstance.apiSchemaRetrieve(format, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiSchemaRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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 *format = format_example; //  (optional)
String *lang = lang_example; //  (optional)

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

[apiInstance apiSchemaRetrieveWith:format
    lang:lang
              completionHandler: ^(NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var opts = { 
  'format': format_example, // {{String}} 
  'lang': lang_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiSchemaRetrieve(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiSchemaRetrieveExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var format = format_example;  // String |  (optional) 
            var lang = lang_example;  // String |  (optional) 

            try
            {
                map['String', null] result = apiInstance.apiSchemaRetrieve(format, lang);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiSchemaRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$format = format_example; // String | 
$lang = lang_example; // String | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $format = format_example; # String | 
my $lang = lang_example; # String | 

eval { 
    my $result = $api_instance->apiSchemaRetrieve(format => $format, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiSchemaRetrieve: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
format = format_example # String |  (optional)
lang = lang_example # String |  (optional)

try: 
    api_response = api_instance.api_schema_retrieve(format=format, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiSchemaRetrieve: %s\n" % e)

Parameters

Query parameters
Name Description
format
String
lang
String

Responses

Status: 200 -


apiTransactionsCreate


/api/transactions/

Usage and SDK Samples

curl -X POST\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/transactions/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Transaction body = ; // Transaction | 
        try {
            Transaction result = apiInstance.apiTransactionsCreate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Transaction body = ; // Transaction | 
        try {
            Transaction result = apiInstance.apiTransactionsCreate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Transaction *body = ; // 

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

[apiInstance apiTransactionsCreateWith:body
              completionHandler: ^(Transaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var body = ; // {{Transaction}} 

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

namespace Example
{
    public class apiTransactionsCreateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var body = new Transaction(); // Transaction | 

            try
            {
                Transaction result = apiInstance.apiTransactionsCreate(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiTransactionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$body = ; // Transaction | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $body = WWW::SwaggerClient::Object::Transaction->new(); # Transaction | 

eval { 
    my $result = $api_instance->apiTransactionsCreate(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransactionsCreate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
body =  # Transaction | 

try: 
    api_response = api_instance.api_transactions_create(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransactionsCreate: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Form parameters
Name Description
id*
Integer
Required
transaction_date*
date (date)
Required
owner*
String
Required
ticker*
String
Required
asset_name*
String
Required
asset_type*
String
Required
amount*
AmountEnum
Required
amount_min*
Double (double)
Required
amount_max*
Double (double)
Required
transaction_type*
TransactionTypeEnum
Required
comment*
String
Required
report_id*
Integer
Required
id*
Integer
Required
transaction_date*
date (date)
Required
owner*
String
Required
ticker*
String
Required
asset_name*
String
Required
asset_type*
String
Required
amount*
AmountEnum
Required
amount_min*
Double (double)
Required
amount_max*
Double (double)
Required
transaction_type*
TransactionTypeEnum
Required
comment*
String
Required
report_id*
Integer
Required
Query parameters
Name Description

Responses

Status: 201 -


apiTransactionsDestroy


/api/transactions/{id}/

Usage and SDK Samples

curl -X DELETE\
\
-H "Authorization: [[apiKey]]"\
"http://127.0.0.1:8000/api/transactions/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        try {
            apiInstance.apiTransactionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsDestroy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        try {
            apiInstance.apiTransactionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *id = 56; // A unique integer value identifying this transaction.

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

[apiInstance apiTransactionsDestroyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var id = 56; // {{Integer}} A unique integer value identifying this transaction.

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

namespace Example
{
    public class apiTransactionsDestroyExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this transaction.

            try
            {
                apiInstance.apiTransactionsDestroy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiTransactionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$id = 56; // Integer | A unique integer value identifying this transaction.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this transaction.

eval { 
    $api_instance->apiTransactionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransactionsDestroy: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
id = 56 # Integer | A unique integer value identifying this transaction.

try: 
    api_instance.api_transactions_destroy(id)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransactionsDestroy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this transaction.
Required
Query parameters
Name Description

Responses

Status: 204 - No response body


apiTransactionsList


/api/transactions/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/transactions/?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        try {
            PaginatedTransactionList result = apiInstance.apiTransactionsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        try {
            PaginatedTransactionList result = apiInstance.apiTransactionsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *limit = 56; // Number of results to return per page. (optional)
Integer *offset = 56; // The initial index from which to return the results. (optional)

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

[apiInstance apiTransactionsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedTransactionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var opts = { 
  'limit': 56, // {{Integer}} Number of results to return per page.
  'offset': 56 // {{Integer}} The initial index from which to return the results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiTransactionsList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiTransactionsListExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional) 
            var offset = 56;  // Integer | The initial index from which to return the results. (optional) 

            try
            {
                PaginatedTransactionList result = apiInstance.apiTransactionsList(limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiTransactionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval { 
    my $result = $api_instance->apiTransactionsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransactionsList: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
limit = 56 # Integer | Number of results to return per page. (optional)
offset = 56 # Integer | The initial index from which to return the results. (optional)

try: 
    api_response = api_instance.api_transactions_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransactionsList: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses

Status: 200 -


apiTransactionsPartialUpdate


/api/transactions/{id}/

Usage and SDK Samples

curl -X PATCH\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/transactions/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        PatchedTransaction body = ; // PatchedTransaction | 
        try {
            Transaction result = apiInstance.apiTransactionsPartialUpdate(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsPartialUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        PatchedTransaction body = ; // PatchedTransaction | 
        try {
            Transaction result = apiInstance.apiTransactionsPartialUpdate(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsPartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *id = 56; // A unique integer value identifying this transaction.
PatchedTransaction *body = ; //  (optional)

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

[apiInstance apiTransactionsPartialUpdateWith:id
    body:body
              completionHandler: ^(Transaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var id = 56; // {{Integer}} A unique integer value identifying this transaction.
var opts = { 
  'body':  // {{PatchedTransaction}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiTransactionsPartialUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiTransactionsPartialUpdateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this transaction.
            var body = new PatchedTransaction(); // PatchedTransaction |  (optional) 

            try
            {
                Transaction result = apiInstance.apiTransactionsPartialUpdate(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiTransactionsPartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$id = 56; // Integer | A unique integer value identifying this transaction.
$body = ; // PatchedTransaction | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this transaction.
my $body = WWW::SwaggerClient::Object::PatchedTransaction->new(); # PatchedTransaction | 

eval { 
    my $result = $api_instance->apiTransactionsPartialUpdate(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransactionsPartialUpdate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
id = 56 # Integer | A unique integer value identifying this transaction.
body =  # PatchedTransaction |  (optional)

try: 
    api_response = api_instance.api_transactions_partial_update(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransactionsPartialUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this transaction.
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
transaction_date
date (date)
owner
String
ticker
String
asset_name
String
asset_type
String
amount
AmountEnum
amount_min
Double (double)
amount_max
Double (double)
transaction_type
TransactionTypeEnum
comment
String
report_id
Integer
id
Integer
transaction_date
date (date)
owner
String
ticker
String
asset_name
String
asset_type
String
amount
AmountEnum
amount_min
Double (double)
amount_max
Double (double)
transaction_type
TransactionTypeEnum
comment
String
report_id
Integer
Query parameters
Name Description

Responses

Status: 200 -


apiTransactionsRetrieve


/api/transactions/{id}/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/transactions/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        try {
            Transaction result = apiInstance.apiTransactionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsRetrieve");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        try {
            Transaction result = apiInstance.apiTransactionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *id = 56; // A unique integer value identifying this transaction.

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

[apiInstance apiTransactionsRetrieveWith:id
              completionHandler: ^(Transaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var id = 56; // {{Integer}} A unique integer value identifying this transaction.

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

namespace Example
{
    public class apiTransactionsRetrieveExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this transaction.

            try
            {
                Transaction result = apiInstance.apiTransactionsRetrieve(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiTransactionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$id = 56; // Integer | A unique integer value identifying this transaction.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this transaction.

eval { 
    my $result = $api_instance->apiTransactionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransactionsRetrieve: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
id = 56 # Integer | A unique integer value identifying this transaction.

try: 
    api_response = api_instance.api_transactions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransactionsRetrieve: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this transaction.
Required
Query parameters
Name Description

Responses

Status: 200 -


apiTransactionsUpdate


/api/transactions/{id}/

Usage and SDK Samples

curl -X PUT\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/transactions/{id}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Transaction body = ; // Transaction | 
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        try {
            Transaction result = apiInstance.apiTransactionsUpdate(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Transaction body = ; // Transaction | 
        Integer id = 56; // Integer | A unique integer value identifying this transaction.
        try {
            Transaction result = apiInstance.apiTransactionsUpdate(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransactionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Transaction *body = ; // 
Integer *id = 56; // A unique integer value identifying this transaction.

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

[apiInstance apiTransactionsUpdateWith:body
    id:id
              completionHandler: ^(Transaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var body = ; // {{Transaction}} 
var id = 56; // {{Integer}} A unique integer value identifying this transaction.

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

namespace Example
{
    public class apiTransactionsUpdateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var body = new Transaction(); // Transaction | 
            var id = 56;  // Integer | A unique integer value identifying this transaction.

            try
            {
                Transaction result = apiInstance.apiTransactionsUpdate(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiTransactionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$body = ; // Transaction | 
$id = 56; // Integer | A unique integer value identifying this transaction.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $body = WWW::SwaggerClient::Object::Transaction->new(); # Transaction | 
my $id = 56; # Integer | A unique integer value identifying this transaction.

eval { 
    my $result = $api_instance->apiTransactionsUpdate(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransactionsUpdate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
body =  # Transaction | 
id = 56 # Integer | A unique integer value identifying this transaction.

try: 
    api_response = api_instance.api_transactions_update(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransactionsUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this transaction.
Required
Body parameters
Name Description
body *
Form parameters
Name Description
id*
Integer
Required
transaction_date*
date (date)
Required
owner*
String
Required
ticker*
String
Required
asset_name*
String
Required
asset_type*
String
Required
amount*
AmountEnum
Required
amount_min*
Double (double)
Required
amount_max*
Double (double)
Required
transaction_type*
TransactionTypeEnum
Required
comment*
String
Required
report_id*
Integer
Required
id*
Integer
Required
transaction_date*
date (date)
Required
owner*
String
Required
ticker*
String
Required
asset_name*
String
Required
asset_type*
String
Required
amount*
AmountEnum
Required
amount_min*
Double (double)
Required
amount_max*
Double (double)
Required
transaction_type*
TransactionTypeEnum
Required
comment*
String
Required
report_id*
Integer
Required
Query parameters
Name Description

Responses

Status: 200 -


apiUsersList


/api/users/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/users/?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        try {
            PaginatedUserList result = apiInstance.apiUsersList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        try {
            PaginatedUserList result = apiInstance.apiUsersList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
Integer *limit = 56; // Number of results to return per page. (optional)
Integer *offset = 56; // The initial index from which to return the results. (optional)

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

[apiInstance apiUsersListWith:limit
    offset:offset
              completionHandler: ^(PaginatedUserList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var opts = { 
  'limit': 56, // {{Integer}} Number of results to return per page.
  'offset': 56 // {{Integer}} The initial index from which to return the results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiUsersList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiUsersListExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional) 
            var offset = 56;  // Integer | The initial index from which to return the results. (optional) 

            try
            {
                PaginatedUserList result = apiInstance.apiUsersList(limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiUsersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval { 
    my $result = $api_instance->apiUsersList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiUsersList: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
limit = 56 # Integer | Number of results to return per page. (optional)
offset = 56 # Integer | The initial index from which to return the results. (optional)

try: 
    api_response = api_instance.api_users_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiUsersList: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses

Status: 200 -


apiUsersMeRetrieve


/api/users/me/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/users/me/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        try {
            User result = apiInstance.apiUsersMeRetrieve();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersMeRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];

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

[apiInstance apiUsersMeRetrieveWithCompletionHandler: 
              ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

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

namespace Example
{
    public class apiUsersMeRetrieveExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();

            try
            {
                User result = apiInstance.apiUsersMeRetrieve();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiUsersMeRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();

eval { 
    my $result = $api_instance->apiUsersMeRetrieve();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiUsersMeRetrieve: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()

try: 
    api_response = api_instance.api_users_me_retrieve()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiUsersMeRetrieve: %s\n" % e)

Parameters

Query parameters
Name Description

Responses

Status: 200 -


apiUsersPartialUpdate


/api/users/{username}/

Usage and SDK Samples

curl -X PATCH\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/users/{username}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        String username = username_example; // String | 
        PatchedUser body = ; // PatchedUser | 
        try {
            User result = apiInstance.apiUsersPartialUpdate(username, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersPartialUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String username = username_example; // String | 
        PatchedUser body = ; // PatchedUser | 
        try {
            User result = apiInstance.apiUsersPartialUpdate(username, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersPartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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 *username = username_example; // 
PatchedUser *body = ; //  (optional)

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

[apiInstance apiUsersPartialUpdateWith:username
    body:body
              completionHandler: ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var username = username_example; // {{String}} 
var opts = { 
  'body':  // {{PatchedUser}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiUsersPartialUpdate(username, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiUsersPartialUpdateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var username = username_example;  // String | 
            var body = new PatchedUser(); // PatchedUser |  (optional) 

            try
            {
                User result = apiInstance.apiUsersPartialUpdate(username, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiUsersPartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$username = username_example; // String | 
$body = ; // PatchedUser | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $username = username_example; # String | 
my $body = WWW::SwaggerClient::Object::PatchedUser->new(); # PatchedUser | 

eval { 
    my $result = $api_instance->apiUsersPartialUpdate(username => $username, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiUsersPartialUpdate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
username = username_example # String | 
body =  # PatchedUser |  (optional)

try: 
    api_response = api_instance.api_users_partial_update(username, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiUsersPartialUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
username
String
name
String
url
String (uri)
username
String
name
String
url
String (uri)
Query parameters
Name Description

Responses

Status: 200 -


apiUsersRetrieve


/api/users/{username}/

Usage and SDK Samples

curl -X GET\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"http://127.0.0.1:8000/api/users/{username}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        String username = username_example; // String | 
        try {
            User result = apiInstance.apiUsersRetrieve(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersRetrieve");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String username = username_example; // String | 
        try {
            User result = apiInstance.apiUsersRetrieve(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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 *username = username_example; // 

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

[apiInstance apiUsersRetrieveWith:username
              completionHandler: ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var username = username_example; // {{String}} 

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

namespace Example
{
    public class apiUsersRetrieveExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var username = username_example;  // String | 

            try
            {
                User result = apiInstance.apiUsersRetrieve(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiUsersRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$username = username_example; // String | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $username = username_example; # String | 

eval { 
    my $result = $api_instance->apiUsersRetrieve(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiUsersRetrieve: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
username = username_example # String | 

try: 
    api_response = api_instance.api_users_retrieve(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiUsersRetrieve: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description

Responses

Status: 200 -


apiUsersUpdate


/api/users/{username}/

Usage and SDK Samples

curl -X PUT\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"http://127.0.0.1:8000/api/users/{username}/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        ApiApi apiInstance = new ApiApi();
        User body = ; // User | 
        String username = username_example; // String | 
        try {
            User result = apiInstance.apiUsersUpdate(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        User body = ; // User | 
        String username = username_example; // String | 
        try {
            User result = apiInstance.apiUsersUpdate(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiUsersUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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"];
User *body = ; // 
String *username = username_example; // 

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

[apiInstance apiUsersUpdateWith:body
    username:username
              completionHandler: ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.ApiApi()
var body = ; // {{User}} 
var username = username_example; // {{String}} 

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

namespace Example
{
    public class apiUsersUpdateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 ApiApi();
            var body = new User(); // User | 
            var username = username_example;  // String | 

            try
            {
                User result = apiInstance.apiUsersUpdate(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.apiUsersUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiApiApi();
$body = ; // User | 
$username = username_example; // String | 

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

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::ApiApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | 
my $username = username_example; # String | 

eval { 
    my $result = $api_instance->apiUsersUpdate(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiUsersUpdate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.ApiApi()
body =  # User | 
username = username_example # String | 

try: 
    api_response = api_instance.api_users_update(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiUsersUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
Required
Body parameters
Name Description
body *
Form parameters
Name Description
username*
String
Required
name*
String
Required
url*
String (uri)
Required
username*
String
Required
name*
String
Required
url*
String (uri)
Required
Query parameters
Name Description

Responses

Status: 200 -


AuthToken

authTokenCreate


/auth-token/

Usage and SDK Samples

curl -X POST\
\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded,multipart/form-data,application/json"\
"http://127.0.0.1:8000/auth-token/?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthTokenApi;

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

public class AuthTokenApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

        AuthTokenApi apiInstance = new AuthTokenApi();
        String username2 = username_example; // String | 
        String password2 = password_example; // String | 
        String token2 = token_example; // String | 
        String username = username_example; // String | 
        String password = password_example; // String | 
        String token = token_example; // String | 
        try {
            AuthToken result = apiInstance.authTokenCreate(username2, password2, token2, username, password, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthTokenApi#authTokenCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthTokenApi;

public class AuthTokenApiExample {

    public static void main(String[] args) {
        AuthTokenApi apiInstance = new AuthTokenApi();
        String username2 = username_example; // String | 
        String password2 = password_example; // String | 
        String token2 = token_example; // String | 
        String username = username_example; // String | 
        String password = password_example; // String | 
        String token = token_example; // String | 
        try {
            AuthToken result = apiInstance.authTokenCreate(username2, password2, token2, username, password, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthTokenApi#authTokenCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[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 *username2 = username_example; // 
String *password2 = password_example; // 
String *token2 = token_example; // 
String *username = username_example; // 
String *password = password_example; // 
String *token = token_example; // 

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

[apiInstance authTokenCreateWith:username2
    password2:password2
    token2:token2
    username:username
    password:password
    token:token
              completionHandler: ^(AuthToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DirectableApi = require('directable_api');
var defaultClient = DirectableApi.ApiClient.instance;

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

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

var api = new DirectableApi.AuthTokenApi()
var username2 = username_example; // {{String}} 
var password2 = password_example; // {{String}} 
var token2 = token_example; // {{String}} 
var username = username_example; // {{String}} 
var password = password_example; // {{String}} 
var token = token_example; // {{String}} 

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

namespace Example
{
    public class authTokenCreateExample
    {
        public void main()
        {

            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: tokenAuth
            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 AuthTokenApi();
            var username2 = username_example;  // String | 
            var password2 = password_example;  // String | 
            var token2 = token_example;  // String | 
            var username = username_example;  // String | 
            var password = password_example;  // String | 
            var token = token_example;  // String | 

            try
            {
                AuthToken result = apiInstance.authTokenCreate(username2, password2, token2, username, password, token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthTokenApi.authTokenCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cookieAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');
// Configure API key authorization: tokenAuth
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\ApiAuthTokenApi();
$username2 = username_example; // String | 
$password2 = password_example; // String | 
$token2 = token_example; // String | 
$username = username_example; // String | 
$password = password_example; // String | 
$token = token_example; // String | 

try {
    $result = $api_instance->authTokenCreate($username2, $password2, $token2, $username, $password, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthTokenApi->authTokenCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthTokenApi;

# Configure API key authorization: cookieAuth
$WWW::SwaggerClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";
# Configure API key authorization: tokenAuth
$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::AuthTokenApi->new();
my $username2 = username_example; # String | 
my $password2 = password_example; # String | 
my $token2 = token_example; # String | 
my $username = username_example; # String | 
my $password = password_example; # String | 
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->authTokenCreate(username2 => $username2, password2 => $password2, token2 => $token2, username => $username, password => $password, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthTokenApi->authTokenCreate: $@\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: cookieAuth
swagger_client.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['sessionid'] = 'Bearer'
# Configure API key authorization: tokenAuth
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.AuthTokenApi()
username2 = username_example # String | 
password2 = password_example # String | 
token2 = token_example # String | 
username = username_example # String | 
password = password_example # String | 
token = token_example # String | 

try: 
    api_response = api_instance.auth_token_create(username2, password2, token2, username, password, token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthTokenApi->authTokenCreate: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Form parameters
Name Description
username*
String
Required
password*
String
Required
token*
String
Required
username*
String
Required
password*
String
Required
token*
String
Required
Query parameters
Name Description

Responses

Status: 200 -