Echo226 Entities API

AdvertiserDashboard

disqualifiedConversionsReportForAdvertiserDashboard

Disqualified Conversions Report For Advertiser Dashboard


/2015-03-01/dashboard/advertiser/{advertiserId}/report/disqualified_conversions

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/report/disqualified_conversions?dateRange=&fields=&format=&filter=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        String dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
        String fields = fields_example; // String | 
        String format = format_example; // String | results format 'json' or 'csv'
        String filter = filter_example; // String | Report Filters - see explanation above

        Integer limit = 56; // Integer | number of records that should be returned
        try {
            AdvertiserDisqualifiedConversionsReport result = apiInstance.disqualifiedConversionsReportForAdvertiserDashboard(advertiserId, dateRange, fields, format, filter, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#disqualifiedConversionsReportForAdvertiserDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        String dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
        String fields = fields_example; // String | 
        String format = format_example; // String | results format 'json' or 'csv'
        String filter = filter_example; // String | Report Filters - see explanation above

        Integer limit = 56; // Integer | number of records that should be returned
        try {
            AdvertiserDisqualifiedConversionsReport result = apiInstance.disqualifiedConversionsReportForAdvertiserDashboard(advertiserId, dateRange, fields, format, filter, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#disqualifiedConversionsReportForAdvertiserDashboard");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
String *dateRange = dateRange_example; // date range YYYY-MM-DD-YYYY-MM-DD
String *fields = fields_example; // 
String *format = format_example; // results format 'json' or 'csv' (optional)
String *filter = filter_example; // Report Filters - see explanation above
 (optional)
Integer *limit = 56; // number of records that should be returned (optional)

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

[apiInstance disqualifiedConversionsReportForAdvertiserDashboardWith:advertiserId
    dateRange:dateRange
    fields:fields
    format:format
    filter:filter
    limit:limit
              completionHandler: ^(AdvertiserDisqualifiedConversionsReport output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 789; // {Long} ID of advertiser

var dateRange = dateRange_example; // {String} date range YYYY-MM-DD-YYYY-MM-DD

var fields = fields_example; // {String} 

var opts = { 
  'format': format_example, // {String} results format 'json' or 'csv'
  'filter': filter_example, // {String} Report Filters - see explanation above

  'limit': 56 // {Integer} number of records that should be returned
};

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

namespace Example
{
    public class disqualifiedConversionsReportForAdvertiserDashboardExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var dateRange = dateRange_example;  // String | date range YYYY-MM-DD-YYYY-MM-DD
            var fields = fields_example;  // String | 
            var format = format_example;  // String | results format 'json' or 'csv' (optional) 
            var filter = filter_example;  // String | Report Filters - see explanation above
 (optional) 
            var limit = 56;  // Integer | number of records that should be returned (optional) 

            try
            {
                AdvertiserDisqualifiedConversionsReport result = apiInstance.disqualifiedConversionsReportForAdvertiserDashboard(advertiserId, dateRange, fields, format, filter, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.disqualifiedConversionsReportForAdvertiserDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 789; // Long | ID of advertiser
$dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
$fields = fields_example; // String | 
$format = format_example; // String | results format 'json' or 'csv'
$filter = filter_example; // String | Report Filters - see explanation above

$limit = 56; // Integer | number of records that should be returned

try {
    $result = $api_instance->disqualifiedConversionsReportForAdvertiserDashboard($advertiserId, $dateRange, $fields, $format, $filter, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdvertiserDashboardApi->disqualifiedConversionsReportForAdvertiserDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdvertiserDashboardApi;

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $dateRange = dateRange_example; # String | date range YYYY-MM-DD-YYYY-MM-DD
my $fields = fields_example; # String | 
my $format = format_example; # String | results format 'json' or 'csv'
my $filter = filter_example; # String | Report Filters - see explanation above

my $limit = 56; # Integer | number of records that should be returned

eval { 
    my $result = $api_instance->disqualifiedConversionsReportForAdvertiserDashboard(advertiserId => $advertiserId, dateRange => $dateRange, fields => $fields, format => $format, filter => $filter, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdvertiserDashboardApi->disqualifiedConversionsReportForAdvertiserDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 789 # Long | ID of advertiser
dateRange = dateRange_example # String | date range YYYY-MM-DD-YYYY-MM-DD
fields = fields_example # String | 
format = format_example # String | results format 'json' or 'csv' (optional)
filter = filter_example # String | Report Filters - see explanation above
 (optional)
limit = 56 # Integer | number of records that should be returned (optional)

try: 
    api_response = api_instance.disqualified_conversions_report_for_advertiser_dashboard(advertiserId, dateRange, fields, format=format, filter=filter, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->disqualifiedConversionsReportForAdvertiserDashboard: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
Query parameters
Name Description
dateRange*
String
date range YYYY-MM-DD-YYYY-MM-DD
Required
fields*
String
Required
format
String
results format 'json' or 'csv'
filter
String
Report Filters - see explanation above
limit
Integer (int32)
number of records that should be returned

Responses

Status: 200 - Result of the report. First row will be the headers (columns) and all other rows (if exists) will be the result.

Status: 400 - Invalid input


getAdvDashboardOffer

Get offer information


/2015-03-01/dashboard/advertiser/{advertiserId}/offers/{offerId}

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/offers/{offerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        Long offerId = 789; // Long | ID of offer
        try {
            AdvertiserDashboardOffer result = apiInstance.getAdvDashboardOffer(advertiserId, offerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getAdvDashboardOffer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        Long offerId = 789; // Long | ID of offer
        try {
            AdvertiserDashboardOffer result = apiInstance.getAdvDashboardOffer(advertiserId, offerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getAdvDashboardOffer");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
Long *offerId = 789; // ID of offer

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

// Get offer information
[apiInstance getAdvDashboardOfferWith:advertiserId
    offerId:offerId
              completionHandler: ^(AdvertiserDashboardOffer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 789; // {Long} ID of advertiser

var offerId = 789; // {Long} ID of offer


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

namespace Example
{
    public class getAdvDashboardOfferExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var offerId = 789;  // Long | ID of offer

            try
            {
                // Get offer information
                AdvertiserDashboardOffer result = apiInstance.getAdvDashboardOffer(advertiserId, offerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.getAdvDashboardOffer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 789; // Long | ID of advertiser
$offerId = 789; // Long | ID of offer

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

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $offerId = 789; # Long | ID of offer

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

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 789 # Long | ID of advertiser
offerId = 789 # Long | ID of offer

try: 
    # Get offer information
    api_response = api_instance.get_adv_dashboard_offer(advertiserId, offerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->getAdvDashboardOffer: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
offerId*
Long (int64)
ID of offer
Required

Responses

Status: 200 - Success


getDashboardAdvertiserAccount

Get advertiser information


/2015-03-01/dashboard/advertiser/{advertiserId}/account

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/account"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Integer advertiserId = 56; // Integer | advertiser id
        try {
            AdvertiserDashboardAccount result = apiInstance.getDashboardAdvertiserAccount(advertiserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getDashboardAdvertiserAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Integer advertiserId = 56; // Integer | advertiser id
        try {
            AdvertiserDashboardAccount result = apiInstance.getDashboardAdvertiserAccount(advertiserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getDashboardAdvertiserAccount");
            e.printStackTrace();
        }
    }
}
Integer *advertiserId = 56; // advertiser id

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

// Get advertiser information
[apiInstance getDashboardAdvertiserAccountWith:advertiserId
              completionHandler: ^(AdvertiserDashboardAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 56; // {Integer} advertiser id


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

namespace Example
{
    public class getDashboardAdvertiserAccountExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 56;  // Integer | advertiser id

            try
            {
                // Get advertiser information
                AdvertiserDashboardAccount result = apiInstance.getDashboardAdvertiserAccount(advertiserId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.getDashboardAdvertiserAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 56; // Integer | advertiser id

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

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 56; # Integer | advertiser id

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

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 56 # Integer | advertiser id

try: 
    # Get advertiser information
    api_response = api_instance.get_dashboard_advertiser_account(advertiserId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->getDashboardAdvertiserAccount: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Integer (int32)
advertiser id
Required

Responses

Status: 200 -

Status: 400 - Invalid input


getDashboardAdvertiserOffers

Get list of advertiser offers


/2015-03-01/dashboard/advertiser/{advertiserId}/offers/all

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/offers/all?start=&rows=&sort=&dir="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Integer advertiserId = 56; // Integer | affiliate id
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | 
        try {
            inline_response_200_15 result = apiInstance.getDashboardAdvertiserOffers(advertiserId, start, rows, sort, dir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getDashboardAdvertiserOffers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Integer advertiserId = 56; // Integer | affiliate id
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | 
        try {
            inline_response_200_15 result = apiInstance.getDashboardAdvertiserOffers(advertiserId, start, rows, sort, dir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getDashboardAdvertiserOffers");
            e.printStackTrace();
        }
    }
}
Integer *advertiserId = 56; // affiliate id
Integer *start = 56; // to start from (optional)
Integer *rows = 56; // rows count that should be returned (optional)
String *sort = sort_example; // field name to sort by (optional)
String *dir = dir_example; //  (optional)

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

// Get list of advertiser offers
[apiInstance getDashboardAdvertiserOffersWith:advertiserId
    start:start
    rows:rows
    sort:sort
    dir:dir
              completionHandler: ^(inline_response_200_15 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 56; // {Integer} affiliate id

var opts = { 
  'start': 56, // {Integer} to start from
  'rows': 56, // {Integer} rows count that should be returned
  'sort': sort_example, // {String} field name to sort by
  'dir': dir_example // {String} 
};

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

namespace Example
{
    public class getDashboardAdvertiserOffersExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 56;  // Integer | affiliate id
            var start = 56;  // Integer | to start from (optional) 
            var rows = 56;  // Integer | rows count that should be returned (optional) 
            var sort = sort_example;  // String | field name to sort by (optional) 
            var dir = dir_example;  // String |  (optional) 

            try
            {
                // Get list of advertiser offers
                inline_response_200_15 result = apiInstance.getDashboardAdvertiserOffers(advertiserId, start, rows, sort, dir);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.getDashboardAdvertiserOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 56; // Integer | affiliate id
$start = 56; // Integer | to start from
$rows = 56; // Integer | rows count that should be returned
$sort = sort_example; // String | field name to sort by
$dir = dir_example; // String | 

try {
    $result = $api_instance->getDashboardAdvertiserOffers($advertiserId, $start, $rows, $sort, $dir);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdvertiserDashboardApi->getDashboardAdvertiserOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdvertiserDashboardApi;

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 56; # Integer | affiliate id
my $start = 56; # Integer | to start from
my $rows = 56; # Integer | rows count that should be returned
my $sort = sort_example; # String | field name to sort by
my $dir = dir_example; # String | 

eval { 
    my $result = $api_instance->getDashboardAdvertiserOffers(advertiserId => $advertiserId, start => $start, rows => $rows, sort => $sort, dir => $dir);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdvertiserDashboardApi->getDashboardAdvertiserOffers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 56 # Integer | affiliate id
start = 56 # Integer | to start from (optional)
rows = 56 # Integer | rows count that should be returned (optional)
sort = sort_example # String | field name to sort by (optional)
dir = dir_example # String |  (optional)

try: 
    # Get list of advertiser offers
    api_response = api_instance.get_dashboard_advertiser_offers(advertiserId, start=start, rows=rows, sort=sort, dir=dir)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->getDashboardAdvertiserOffers: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Integer (int32)
affiliate id
Required
Query parameters
Name Description
start
Integer (int32)
to start from
rows
Integer (int32)
rows count that should be returned
sort
String
field name to sort by
dir
String

Responses

Status: 200 -

Status: 400 - Invalid input


getDashboardAdvertiserUsers

Get advertiser contacts information


/2015-03-01/dashboard/advertiser/{advertiserId}/users

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Integer advertiserId = 56; // Integer | advertiser id
        try {
            AdvertiserDashboardUsers result = apiInstance.getDashboardAdvertiserUsers(advertiserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getDashboardAdvertiserUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Integer advertiserId = 56; // Integer | advertiser id
        try {
            AdvertiserDashboardUsers result = apiInstance.getDashboardAdvertiserUsers(advertiserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#getDashboardAdvertiserUsers");
            e.printStackTrace();
        }
    }
}
Integer *advertiserId = 56; // advertiser id

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

// Get advertiser contacts information
[apiInstance getDashboardAdvertiserUsersWith:advertiserId
              completionHandler: ^(AdvertiserDashboardUsers output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 56; // {Integer} advertiser id


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

namespace Example
{
    public class getDashboardAdvertiserUsersExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 56;  // Integer | advertiser id

            try
            {
                // Get advertiser contacts information
                AdvertiserDashboardUsers result = apiInstance.getDashboardAdvertiserUsers(advertiserId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.getDashboardAdvertiserUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 56; // Integer | advertiser id

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

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 56; # Integer | advertiser id

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

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 56 # Integer | advertiser id

try: 
    # Get advertiser contacts information
    api_response = api_instance.get_dashboard_advertiser_users(advertiserId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->getDashboardAdvertiserUsers: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Integer (int32)
advertiser id
Required

Responses

Status: 200 -

Status: 400 - Invalid input


performanceReportForAdvertiserDashboard

Performance Report For Advertiser Dashboard


/2015-03-01/dashboard/advertiser/{advertiserId}/report/performance

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/report/performance?dateRange=&fields=&format=&filter=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        String dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
        String fields = fields_example; // String | 
        String format = format_example; // String | results format 'json' or 'csv'
        String filter = filter_example; // String | Report Filters - see explanation above

        Integer limit = 56; // Integer | number of records that should be returned
        try {
            AdvertiserPerformanceReport result = apiInstance.performanceReportForAdvertiserDashboard(advertiserId, dateRange, fields, format, filter, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#performanceReportForAdvertiserDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        String dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
        String fields = fields_example; // String | 
        String format = format_example; // String | results format 'json' or 'csv'
        String filter = filter_example; // String | Report Filters - see explanation above

        Integer limit = 56; // Integer | number of records that should be returned
        try {
            AdvertiserPerformanceReport result = apiInstance.performanceReportForAdvertiserDashboard(advertiserId, dateRange, fields, format, filter, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#performanceReportForAdvertiserDashboard");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
String *dateRange = dateRange_example; // date range YYYY-MM-DD-YYYY-MM-DD
String *fields = fields_example; // 
String *format = format_example; // results format 'json' or 'csv' (optional)
String *filter = filter_example; // Report Filters - see explanation above
 (optional)
Integer *limit = 56; // number of records that should be returned (optional)

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

[apiInstance performanceReportForAdvertiserDashboardWith:advertiserId
    dateRange:dateRange
    fields:fields
    format:format
    filter:filter
    limit:limit
              completionHandler: ^(AdvertiserPerformanceReport output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 789; // {Long} ID of advertiser

var dateRange = dateRange_example; // {String} date range YYYY-MM-DD-YYYY-MM-DD

var fields = fields_example; // {String} 

var opts = { 
  'format': format_example, // {String} results format 'json' or 'csv'
  'filter': filter_example, // {String} Report Filters - see explanation above

  'limit': 56 // {Integer} number of records that should be returned
};

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

namespace Example
{
    public class performanceReportForAdvertiserDashboardExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var dateRange = dateRange_example;  // String | date range YYYY-MM-DD-YYYY-MM-DD
            var fields = fields_example;  // String | 
            var format = format_example;  // String | results format 'json' or 'csv' (optional) 
            var filter = filter_example;  // String | Report Filters - see explanation above
 (optional) 
            var limit = 56;  // Integer | number of records that should be returned (optional) 

            try
            {
                AdvertiserPerformanceReport result = apiInstance.performanceReportForAdvertiserDashboard(advertiserId, dateRange, fields, format, filter, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.performanceReportForAdvertiserDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 789; // Long | ID of advertiser
$dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
$fields = fields_example; // String | 
$format = format_example; // String | results format 'json' or 'csv'
$filter = filter_example; // String | Report Filters - see explanation above

$limit = 56; // Integer | number of records that should be returned

try {
    $result = $api_instance->performanceReportForAdvertiserDashboard($advertiserId, $dateRange, $fields, $format, $filter, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdvertiserDashboardApi->performanceReportForAdvertiserDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdvertiserDashboardApi;

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $dateRange = dateRange_example; # String | date range YYYY-MM-DD-YYYY-MM-DD
my $fields = fields_example; # String | 
my $format = format_example; # String | results format 'json' or 'csv'
my $filter = filter_example; # String | Report Filters - see explanation above

my $limit = 56; # Integer | number of records that should be returned

eval { 
    my $result = $api_instance->performanceReportForAdvertiserDashboard(advertiserId => $advertiserId, dateRange => $dateRange, fields => $fields, format => $format, filter => $filter, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdvertiserDashboardApi->performanceReportForAdvertiserDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 789 # Long | ID of advertiser
dateRange = dateRange_example # String | date range YYYY-MM-DD-YYYY-MM-DD
fields = fields_example # String | 
format = format_example # String | results format 'json' or 'csv' (optional)
filter = filter_example # String | Report Filters - see explanation above
 (optional)
limit = 56 # Integer | number of records that should be returned (optional)

try: 
    api_response = api_instance.performance_report_for_advertiser_dashboard(advertiserId, dateRange, fields, format=format, filter=filter, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->performanceReportForAdvertiserDashboard: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
Query parameters
Name Description
dateRange*
String
date range YYYY-MM-DD-YYYY-MM-DD
Required
fields*
String
Required
format
String
results format 'json' or 'csv'
filter
String
Report Filters - see explanation above
limit
Integer (int32)
number of records that should be returned

Responses

Status: 200 - Result of the report. First row will be the headers (columns) and all other rows (if exists) will be the result.

Status: 400 - Invalid input


updateAdvDashboardOffer

Update specified offer


/2015-03-01/dashboard/advertiser/{advertiserId}/offers/{offerId}

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/offers/{offerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        Long offerId = 789; // Long | ID of offer
        AdvertiserDashboardUpdateOffer payload = ; // AdvertiserDashboardUpdateOffer | Updated offer data
        try {
            inline_response_200_2 result = apiInstance.updateAdvDashboardOffer(advertiserId, offerId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#updateAdvDashboardOffer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        Long offerId = 789; // Long | ID of offer
        AdvertiserDashboardUpdateOffer payload = ; // AdvertiserDashboardUpdateOffer | Updated offer data
        try {
            inline_response_200_2 result = apiInstance.updateAdvDashboardOffer(advertiserId, offerId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#updateAdvDashboardOffer");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
Long *offerId = 789; // ID of offer
AdvertiserDashboardUpdateOffer *payload = ; // Updated offer data

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

// Update specified offer
[apiInstance updateAdvDashboardOfferWith:advertiserId
    offerId:offerId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 789; // {Long} ID of advertiser

var offerId = 789; // {Long} ID of offer

var payload = ; // {AdvertiserDashboardUpdateOffer} Updated offer data


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

namespace Example
{
    public class updateAdvDashboardOfferExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var offerId = 789;  // Long | ID of offer
            var payload = new AdvertiserDashboardUpdateOffer(); // AdvertiserDashboardUpdateOffer | Updated offer data

            try
            {
                // Update specified offer
                inline_response_200_2 result = apiInstance.updateAdvDashboardOffer(advertiserId, offerId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.updateAdvDashboardOffer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 789; // Long | ID of advertiser
$offerId = 789; // Long | ID of offer
$payload = ; // AdvertiserDashboardUpdateOffer | Updated offer data

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

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $offerId = 789; # Long | ID of offer
my $payload = WWW::SwaggerClient::Object::AdvertiserDashboardUpdateOffer->new(); # AdvertiserDashboardUpdateOffer | Updated offer data

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

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 789 # Long | ID of advertiser
offerId = 789 # Long | ID of offer
payload =  # AdvertiserDashboardUpdateOffer | Updated offer data

try: 
    # Update specified offer
    api_response = api_instance.update_adv_dashboard_offer(advertiserId, offerId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->updateAdvDashboardOffer: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
offerId*
Long (int64)
ID of offer
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


updateDashboardAdvertiserAccount

Update dashboard advertiser


/2015-03-01/dashboard/advertiser/{advertiserId}/account

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/account"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        AdvertiserDashboardAccountUpdate payload = ; // AdvertiserDashboardAccountUpdate | Updated advertiser data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAdvertiserAccount(advertiserId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#updateDashboardAdvertiserAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        AdvertiserDashboardAccountUpdate payload = ; // AdvertiserDashboardAccountUpdate | Updated advertiser data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAdvertiserAccount(advertiserId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#updateDashboardAdvertiserAccount");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
AdvertiserDashboardAccountUpdate *payload = ; // Updated advertiser data

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

// Update dashboard advertiser
[apiInstance updateDashboardAdvertiserAccountWith:advertiserId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 789; // {Long} ID of advertiser

var payload = ; // {AdvertiserDashboardAccountUpdate} Updated advertiser data


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

namespace Example
{
    public class updateDashboardAdvertiserAccountExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var payload = new AdvertiserDashboardAccountUpdate(); // AdvertiserDashboardAccountUpdate | Updated advertiser data

            try
            {
                // Update dashboard advertiser
                inline_response_200_2 result = apiInstance.updateDashboardAdvertiserAccount(advertiserId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.updateDashboardAdvertiserAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 789; // Long | ID of advertiser
$payload = ; // AdvertiserDashboardAccountUpdate | Updated advertiser data

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

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $payload = WWW::SwaggerClient::Object::AdvertiserDashboardAccountUpdate->new(); # AdvertiserDashboardAccountUpdate | Updated advertiser data

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

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 789 # Long | ID of advertiser
payload =  # AdvertiserDashboardAccountUpdate | Updated advertiser data

try: 
    # Update dashboard advertiser
    api_response = api_instance.update_dashboard_advertiser_account(advertiserId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->updateDashboardAdvertiserAccount: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


updateDashboardAdvertiserUsers

Update dashboard contacts


/2015-03-01/dashboard/advertiser/{advertiserId}/users

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/advertiser/{advertiserId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertiserDashboardApi;

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

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        AdvertiserDashboardAccountUpdate payload = ; // AdvertiserDashboardAccountUpdate | Updated advertiser data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAdvertiserUsers(advertiserId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#updateDashboardAdvertiserUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertiserDashboardApi;

public class AdvertiserDashboardApiExample {

    public static void main(String[] args) {
        AdvertiserDashboardApi apiInstance = new AdvertiserDashboardApi();
        Long advertiserId = 789; // Long | ID of advertiser
        AdvertiserDashboardAccountUpdate payload = ; // AdvertiserDashboardAccountUpdate | Updated advertiser data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAdvertiserUsers(advertiserId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertiserDashboardApi#updateDashboardAdvertiserUsers");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
AdvertiserDashboardAccountUpdate *payload = ; // Updated advertiser data

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

// Update dashboard contacts
[apiInstance updateDashboardAdvertiserUsersWith:advertiserId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertiserDashboardApi()

var advertiserId = 789; // {Long} ID of advertiser

var payload = ; // {AdvertiserDashboardAccountUpdate} Updated advertiser data


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

namespace Example
{
    public class updateDashboardAdvertiserUsersExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertiserDashboardApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var payload = new AdvertiserDashboardAccountUpdate(); // AdvertiserDashboardAccountUpdate | Updated advertiser data

            try
            {
                // Update dashboard contacts
                inline_response_200_2 result = apiInstance.updateDashboardAdvertiserUsers(advertiserId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertiserDashboardApi.updateDashboardAdvertiserUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertiserDashboardApi();
$advertiserId = 789; // Long | ID of advertiser
$payload = ; // AdvertiserDashboardAccountUpdate | Updated advertiser data

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

my $api_instance = WWW::SwaggerClient::AdvertiserDashboardApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $payload = WWW::SwaggerClient::Object::AdvertiserDashboardAccountUpdate->new(); # AdvertiserDashboardAccountUpdate | Updated advertiser data

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

# create an instance of the API class
api_instance = swagger_client.AdvertiserDashboardApi()
advertiserId = 789 # Long | ID of advertiser
payload =  # AdvertiserDashboardAccountUpdate | Updated advertiser data

try: 
    # Update dashboard contacts
    api_response = api_instance.update_dashboard_advertiser_users(advertiserId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertiserDashboardApi->updateDashboardAdvertiserUsers: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


Advertisers

batchAdvertisers

Process bulk operations on advertisers


/2015-03-01/advertisers/batch

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/advertisers/batch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertisersApi;

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

public class AdvertisersApiExample {

    public static void main(String[] args) {
        
        AdvertisersApi apiInstance = new AdvertisersApi();
        Payload_1 payload = ; // Payload_1 | Request data
        try {
            inline_response_200_3 result = apiInstance.batchAdvertisers(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#batchAdvertisers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertisersApi;

public class AdvertisersApiExample {

    public static void main(String[] args) {
        AdvertisersApi apiInstance = new AdvertisersApi();
        Payload_1 payload = ; // Payload_1 | Request data
        try {
            inline_response_200_3 result = apiInstance.batchAdvertisers(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#batchAdvertisers");
            e.printStackTrace();
        }
    }
}
Payload_1 *payload = ; // Request data

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

// Process bulk operations on advertisers
[apiInstance batchAdvertisersWith:payload
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertisersApi()

var payload = ; // {Payload_1} Request data


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

namespace Example
{
    public class batchAdvertisersExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertisersApi();
            var payload = new Payload_1(); // Payload_1 | Request data

            try
            {
                // Process bulk operations on advertisers
                inline_response_200_3 result = apiInstance.batchAdvertisers(payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertisersApi.batchAdvertisers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertisersApi();
$payload = ; // Payload_1 | Request data

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

my $api_instance = WWW::SwaggerClient::AdvertisersApi->new();
my $payload = WWW::SwaggerClient::Object::Payload_1->new(); # Payload_1 | Request data

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

# create an instance of the API class
api_instance = swagger_client.AdvertisersApi()
payload =  # Payload_1 | Request data

try: 
    # Process bulk operations on advertisers
    api_response = api_instance.batch_advertisers(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertisersApi->batchAdvertisers: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 200 -


createAdvertiser

Create new advertiser


/2015-03-01/advertisers

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/advertisers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertisersApi;

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

public class AdvertisersApiExample {

    public static void main(String[] args) {
        
        AdvertisersApi apiInstance = new AdvertisersApi();
        try {
            Advertiser result = apiInstance.createAdvertiser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#createAdvertiser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertisersApi;

public class AdvertisersApiExample {

    public static void main(String[] args) {
        AdvertisersApi apiInstance = new AdvertisersApi();
        try {
            Advertiser result = apiInstance.createAdvertiser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#createAdvertiser");
            e.printStackTrace();
        }
    }
}

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

// Create new advertiser
[apiInstance createAdvertiserWithCompletionHandler: 
              ^(Advertiser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertisersApi()

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

namespace Example
{
    public class createAdvertiserExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertisersApi();

            try
            {
                // Create new advertiser
                Advertiser result = apiInstance.createAdvertiser();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertisersApi.createAdvertiser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

try: 
    # Create new advertiser
    api_response = api_instance.create_advertiser()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertisersApi->createAdvertiser: %s\n" % e)

Parameters

Responses

Status: 200 -


getAdvertiser

Get specified advertiser


/2015-03-01/advertisers/{advertiserId}

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/advertisers/{advertiserId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertisersApi;

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

public class AdvertisersApiExample {

    public static void main(String[] args) {
        
        AdvertisersApi apiInstance = new AdvertisersApi();
        Long advertiserId = 789; // Long | ID of advertiser
        try {
            AdvertiserItem result = apiInstance.getAdvertiser(advertiserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#getAdvertiser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertisersApi;

public class AdvertisersApiExample {

    public static void main(String[] args) {
        AdvertisersApi apiInstance = new AdvertisersApi();
        Long advertiserId = 789; // Long | ID of advertiser
        try {
            AdvertiserItem result = apiInstance.getAdvertiser(advertiserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#getAdvertiser");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser

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

// Get specified advertiser
[apiInstance getAdvertiserWith:advertiserId
              completionHandler: ^(AdvertiserItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertisersApi()

var advertiserId = 789; // {Long} ID of advertiser


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

namespace Example
{
    public class getAdvertiserExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertisersApi();
            var advertiserId = 789;  // Long | ID of advertiser

            try
            {
                // Get specified advertiser
                AdvertiserItem result = apiInstance.getAdvertiser(advertiserId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertisersApi.getAdvertiser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertisersApi();
$advertiserId = 789; // Long | ID of advertiser

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

my $api_instance = WWW::SwaggerClient::AdvertisersApi->new();
my $advertiserId = 789; # Long | ID of advertiser

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

# create an instance of the API class
api_instance = swagger_client.AdvertisersApi()
advertiserId = 789 # Long | ID of advertiser

try: 
    # Get specified advertiser
    api_response = api_instance.get_advertiser(advertiserId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertisersApi->getAdvertiser: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required

Responses

Status: 200 -

Status: 400 - Invalid input


getAdvertisers

Get list of advertisers


/2015-03-01/advertisers

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/advertisers?id=&start=&rows=&timeframe=&sort=&dir=&format=&name=&status=&manager=&salesManager=&budget=&dailyCapping=¤cy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertisersApi;

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

public class AdvertisersApiExample {

    public static void main(String[] args) {
        
        AdvertisersApi apiInstance = new AdvertisersApi();
        Long id = 789; // Long | ID of Advertiser
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String timeframe = timeframe_example; // String | affiliate statistics time frame
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | direction of sort 'asce' or 'desc'
        String format = format_example; // String | results format 'json' or 'csv'
        String name = name_example; // String | account name
        String status = status_example; // String | 
        String manager = manager_example; // String | manager email
        String salesManager = salesManager_example; // String | sales manager email
        Integer budget = 56; // Integer | (>=|=|<=) budget
        Integer dailyCapping = 56; // Integer | (>=|=|<=) daily capping
        String currency = currency_example; // String | 
        try {
            inline_response_200_5 result = apiInstance.getAdvertisers(id, start, rows, timeframe, sort, dir, format, name, status, manager, salesManager, budget, dailyCapping, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#getAdvertisers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertisersApi;

public class AdvertisersApiExample {

    public static void main(String[] args) {
        AdvertisersApi apiInstance = new AdvertisersApi();
        Long id = 789; // Long | ID of Advertiser
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String timeframe = timeframe_example; // String | affiliate statistics time frame
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | direction of sort 'asce' or 'desc'
        String format = format_example; // String | results format 'json' or 'csv'
        String name = name_example; // String | account name
        String status = status_example; // String | 
        String manager = manager_example; // String | manager email
        String salesManager = salesManager_example; // String | sales manager email
        Integer budget = 56; // Integer | (>=|=|<=) budget
        Integer dailyCapping = 56; // Integer | (>=|=|<=) daily capping
        String currency = currency_example; // String | 
        try {
            inline_response_200_5 result = apiInstance.getAdvertisers(id, start, rows, timeframe, sort, dir, format, name, status, manager, salesManager, budget, dailyCapping, currency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#getAdvertisers");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // ID of Advertiser (optional)
Integer *start = 56; // to start from (optional)
Integer *rows = 56; // rows count that should be returned (optional)
String *timeframe = timeframe_example; // affiliate statistics time frame (optional)
String *sort = sort_example; // field name to sort by (optional)
String *dir = dir_example; // direction of sort 'asce' or 'desc' (optional)
String *format = format_example; // results format 'json' or 'csv' (optional)
String *name = name_example; // account name (optional)
String *status = status_example; //  (optional)
String *manager = manager_example; // manager email (optional)
String *salesManager = salesManager_example; // sales manager email (optional)
Integer *budget = 56; // (>=|=|<=) budget (optional)
Integer *dailyCapping = 56; // (>=|=|<=) daily capping (optional)
String *currency = currency_example; //  (optional)

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

// Get list of advertisers
[apiInstance getAdvertisersWith:id
    start:start
    rows:rows
    timeframe:timeframe
    sort:sort
    dir:dir
    format:format
    name:name
    status:status
    manager:manager
    salesManager:salesManager
    budget:budget
    dailyCapping:dailyCapping
    currency:currency
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertisersApi()

var opts = { 
  'id': 789, // {Long} ID of Advertiser
  'start': 56, // {Integer} to start from
  'rows': 56, // {Integer} rows count that should be returned
  'timeframe': timeframe_example, // {String} affiliate statistics time frame
  'sort': sort_example, // {String} field name to sort by
  'dir': dir_example, // {String} direction of sort 'asce' or 'desc'
  'format': format_example, // {String} results format 'json' or 'csv'
  'name': name_example, // {String} account name
  'status': status_example, // {String} 
  'manager': manager_example, // {String} manager email
  'salesManager': salesManager_example, // {String} sales manager email
  'budget': 56, // {Integer} (>=|=|<=) budget
  'dailyCapping': 56, // {Integer} (>=|=|<=) daily capping
  'currency': currency_example // {String} 
};

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

namespace Example
{
    public class getAdvertisersExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertisersApi();
            var id = 789;  // Long | ID of Advertiser (optional) 
            var start = 56;  // Integer | to start from (optional) 
            var rows = 56;  // Integer | rows count that should be returned (optional) 
            var timeframe = timeframe_example;  // String | affiliate statistics time frame (optional) 
            var sort = sort_example;  // String | field name to sort by (optional) 
            var dir = dir_example;  // String | direction of sort 'asce' or 'desc' (optional) 
            var format = format_example;  // String | results format 'json' or 'csv' (optional) 
            var name = name_example;  // String | account name (optional) 
            var status = status_example;  // String |  (optional) 
            var manager = manager_example;  // String | manager email (optional) 
            var salesManager = salesManager_example;  // String | sales manager email (optional) 
            var budget = 56;  // Integer | (>=|=|<=) budget (optional) 
            var dailyCapping = 56;  // Integer | (>=|=|<=) daily capping (optional) 
            var currency = currency_example;  // String |  (optional) 

            try
            {
                // Get list of advertisers
                inline_response_200_5 result = apiInstance.getAdvertisers(id, start, rows, timeframe, sort, dir, format, name, status, manager, salesManager, budget, dailyCapping, currency);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertisersApi.getAdvertisers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertisersApi();
$id = 789; // Long | ID of Advertiser
$start = 56; // Integer | to start from
$rows = 56; // Integer | rows count that should be returned
$timeframe = timeframe_example; // String | affiliate statistics time frame
$sort = sort_example; // String | field name to sort by
$dir = dir_example; // String | direction of sort 'asce' or 'desc'
$format = format_example; // String | results format 'json' or 'csv'
$name = name_example; // String | account name
$status = status_example; // String | 
$manager = manager_example; // String | manager email
$salesManager = salesManager_example; // String | sales manager email
$budget = 56; // Integer | (>=|=|<=) budget
$dailyCapping = 56; // Integer | (>=|=|<=) daily capping
$currency = currency_example; // String | 

try {
    $result = $api_instance->getAdvertisers($id, $start, $rows, $timeframe, $sort, $dir, $format, $name, $status, $manager, $salesManager, $budget, $dailyCapping, $currency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdvertisersApi->getAdvertisers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdvertisersApi;

my $api_instance = WWW::SwaggerClient::AdvertisersApi->new();
my $id = 789; # Long | ID of Advertiser
my $start = 56; # Integer | to start from
my $rows = 56; # Integer | rows count that should be returned
my $timeframe = timeframe_example; # String | affiliate statistics time frame
my $sort = sort_example; # String | field name to sort by
my $dir = dir_example; # String | direction of sort 'asce' or 'desc'
my $format = format_example; # String | results format 'json' or 'csv'
my $name = name_example; # String | account name
my $status = status_example; # String | 
my $manager = manager_example; # String | manager email
my $salesManager = salesManager_example; # String | sales manager email
my $budget = 56; # Integer | (>=|=|<=) budget
my $dailyCapping = 56; # Integer | (>=|=|<=) daily capping
my $currency = currency_example; # String | 

eval { 
    my $result = $api_instance->getAdvertisers(id => $id, start => $start, rows => $rows, timeframe => $timeframe, sort => $sort, dir => $dir, format => $format, name => $name, status => $status, manager => $manager, salesManager => $salesManager, budget => $budget, dailyCapping => $dailyCapping, currency => $currency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdvertisersApi->getAdvertisers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdvertisersApi()
id = 789 # Long | ID of Advertiser (optional)
start = 56 # Integer | to start from (optional)
rows = 56 # Integer | rows count that should be returned (optional)
timeframe = timeframe_example # String | affiliate statistics time frame (optional)
sort = sort_example # String | field name to sort by (optional)
dir = dir_example # String | direction of sort 'asce' or 'desc' (optional)
format = format_example # String | results format 'json' or 'csv' (optional)
name = name_example # String | account name (optional)
status = status_example # String |  (optional)
manager = manager_example # String | manager email (optional)
salesManager = salesManager_example # String | sales manager email (optional)
budget = 56 # Integer | (>=|=|<=) budget (optional)
dailyCapping = 56 # Integer | (>=|=|<=) daily capping (optional)
currency = currency_example # String |  (optional)

try: 
    # Get list of advertisers
    api_response = api_instance.get_advertisers(id=id, start=start, rows=rows, timeframe=timeframe, sort=sort, dir=dir, format=format, name=name, status=status, manager=manager, salesManager=salesManager, budget=budget, dailyCapping=dailyCapping, currency=currency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertisersApi->getAdvertisers: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
ID of Advertiser
start
Integer (int32)
to start from
rows
Integer (int32)
rows count that should be returned
timeframe
String
affiliate statistics time frame
sort
String
field name to sort by
dir
String
direction of sort 'asce' or 'desc'
format
String
results format 'json' or 'csv'
name
String
account name
status
String
manager
String
manager email
salesManager
String
sales manager email
budget
Integer
(>=|=|<=) budget
dailyCapping
Integer
(>=|=|<=) daily capping
currency
String

Responses

Status: 200 -

Status: 400 - Invalid input


updateAdvertiser

Update specified advertiser


/2015-03-01/advertisers/{advertiserId}

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/advertisers/{advertiserId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdvertisersApi;

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

public class AdvertisersApiExample {

    public static void main(String[] args) {
        
        AdvertisersApi apiInstance = new AdvertisersApi();
        Long advertiserId = 789; // Long | ID of advertiser
        Advertiser payload = ; // Advertiser | Updated advertiser data
        try {
            inline_response_200_2 result = apiInstance.updateAdvertiser(advertiserId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#updateAdvertiser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdvertisersApi;

public class AdvertisersApiExample {

    public static void main(String[] args) {
        AdvertisersApi apiInstance = new AdvertisersApi();
        Long advertiserId = 789; // Long | ID of advertiser
        Advertiser payload = ; // Advertiser | Updated advertiser data
        try {
            inline_response_200_2 result = apiInstance.updateAdvertiser(advertiserId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdvertisersApi#updateAdvertiser");
            e.printStackTrace();
        }
    }
}
Long *advertiserId = 789; // ID of advertiser
Advertiser *payload = ; // Updated advertiser data

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

// Update specified advertiser
[apiInstance updateAdvertiserWith:advertiserId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AdvertisersApi()

var advertiserId = 789; // {Long} ID of advertiser

var payload = ; // {Advertiser} Updated advertiser data


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

namespace Example
{
    public class updateAdvertiserExample
    {
        public void main()
        {
            
            var apiInstance = new AdvertisersApi();
            var advertiserId = 789;  // Long | ID of advertiser
            var payload = new Advertiser(); // Advertiser | Updated advertiser data

            try
            {
                // Update specified advertiser
                inline_response_200_2 result = apiInstance.updateAdvertiser(advertiserId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdvertisersApi.updateAdvertiser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdvertisersApi();
$advertiserId = 789; // Long | ID of advertiser
$payload = ; // Advertiser | Updated advertiser data

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

my $api_instance = WWW::SwaggerClient::AdvertisersApi->new();
my $advertiserId = 789; # Long | ID of advertiser
my $payload = WWW::SwaggerClient::Object::Advertiser->new(); # Advertiser | Updated advertiser data

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

# create an instance of the API class
api_instance = swagger_client.AdvertisersApi()
advertiserId = 789 # Long | ID of advertiser
payload =  # Advertiser | Updated advertiser data

try: 
    # Update specified advertiser
    api_response = api_instance.update_advertiser(advertiserId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdvertisersApi->updateAdvertiser: %s\n" % e)

Parameters

Path parameters
Name Description
advertiserId*
Long (int64)
ID of advertiser
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


AffiliateDashboard

getDashboardAffiliateAccount

Get affiliate information


/2015-03-01/dashboard/affiliate/{affiliateId}/account

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/account"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Integer affiliateId = 56; // Integer | affiliate id
        try {
            AffiliateDashboardAccount result = apiInstance.getDashboardAffiliateAccount(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardAffiliateAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Integer affiliateId = 56; // Integer | affiliate id
        try {
            AffiliateDashboardAccount result = apiInstance.getDashboardAffiliateAccount(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardAffiliateAccount");
            e.printStackTrace();
        }
    }
}
Integer *affiliateId = 56; // affiliate id

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

// Get affiliate information
[apiInstance getDashboardAffiliateAccountWith:affiliateId
              completionHandler: ^(AffiliateDashboardAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 56; // {Integer} affiliate id


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

namespace Example
{
    public class getDashboardAffiliateAccountExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 56;  // Integer | affiliate id

            try
            {
                // Get affiliate information
                AffiliateDashboardAccount result = apiInstance.getDashboardAffiliateAccount(affiliateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.getDashboardAffiliateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 56; // Integer | affiliate id

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 56; # Integer | affiliate id

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 56 # Integer | affiliate id

try: 
    # Get affiliate information
    api_response = api_instance.get_dashboard_affiliate_account(affiliateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->getDashboardAffiliateAccount: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Integer (int32)
affiliate id
Required

Responses

Status: 200 -

Status: 400 - Invalid input


getDashboardAffiliateOffers

Get list of affiliate offers


/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{section}

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{section}?start=&rows=&sort=&dir="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Integer affiliateId = 56; // Integer | affiliate id
        String section = section_example; // String | section type
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | 
        try {
            inline_response_200_23 result = apiInstance.getDashboardAffiliateOffers(affiliateId, section, start, rows, sort, dir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardAffiliateOffers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Integer affiliateId = 56; // Integer | affiliate id
        String section = section_example; // String | section type
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | 
        try {
            inline_response_200_23 result = apiInstance.getDashboardAffiliateOffers(affiliateId, section, start, rows, sort, dir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardAffiliateOffers");
            e.printStackTrace();
        }
    }
}
Integer *affiliateId = 56; // affiliate id
String *section = section_example; // section type
Integer *start = 56; // to start from (optional)
Integer *rows = 56; // rows count that should be returned (optional)
String *sort = sort_example; // field name to sort by (optional)
String *dir = dir_example; //  (optional)

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

// Get list of affiliate offers
[apiInstance getDashboardAffiliateOffersWith:affiliateId
    section:section
    start:start
    rows:rows
    sort:sort
    dir:dir
              completionHandler: ^(inline_response_200_23 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 56; // {Integer} affiliate id

var section = section_example; // {String} section type

var opts = { 
  'start': 56, // {Integer} to start from
  'rows': 56, // {Integer} rows count that should be returned
  'sort': sort_example, // {String} field name to sort by
  'dir': dir_example // {String} 
};

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

namespace Example
{
    public class getDashboardAffiliateOffersExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 56;  // Integer | affiliate id
            var section = section_example;  // String | section type
            var start = 56;  // Integer | to start from (optional) 
            var rows = 56;  // Integer | rows count that should be returned (optional) 
            var sort = sort_example;  // String | field name to sort by (optional) 
            var dir = dir_example;  // String |  (optional) 

            try
            {
                // Get list of affiliate offers
                inline_response_200_23 result = apiInstance.getDashboardAffiliateOffers(affiliateId, section, start, rows, sort, dir);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.getDashboardAffiliateOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 56; // Integer | affiliate id
$section = section_example; // String | section type
$start = 56; // Integer | to start from
$rows = 56; // Integer | rows count that should be returned
$sort = sort_example; // String | field name to sort by
$dir = dir_example; // String | 

try {
    $result = $api_instance->getDashboardAffiliateOffers($affiliateId, $section, $start, $rows, $sort, $dir);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateDashboardApi->getDashboardAffiliateOffers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AffiliateDashboardApi;

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 56; # Integer | affiliate id
my $section = section_example; # String | section type
my $start = 56; # Integer | to start from
my $rows = 56; # Integer | rows count that should be returned
my $sort = sort_example; # String | field name to sort by
my $dir = dir_example; # String | 

eval { 
    my $result = $api_instance->getDashboardAffiliateOffers(affiliateId => $affiliateId, section => $section, start => $start, rows => $rows, sort => $sort, dir => $dir);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AffiliateDashboardApi->getDashboardAffiliateOffers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 56 # Integer | affiliate id
section = section_example # String | section type
start = 56 # Integer | to start from (optional)
rows = 56 # Integer | rows count that should be returned (optional)
sort = sort_example # String | field name to sort by (optional)
dir = dir_example # String |  (optional)

try: 
    # Get list of affiliate offers
    api_response = api_instance.get_dashboard_affiliate_offers(affiliateId, section, start=start, rows=rows, sort=sort, dir=dir)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->getDashboardAffiliateOffers: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Integer (int32)
affiliate id
Required
section*
String
section type
Required
Query parameters
Name Description
start
Integer (int32)
to start from
rows
Integer (int32)
rows count that should be returned
sort
String
field name to sort by
dir
String

Responses

Status: 200 -

Status: 400 - Invalid input



getDashboardAffiliateUsers

Get affiliate contacts information


/2015-03-01/dashboard/affiliate/{affiliateId}/users

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Integer affiliateId = 56; // Integer | affiliate id
        try {
            AffiliateDashboardUsers result = apiInstance.getDashboardAffiliateUsers(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardAffiliateUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Integer affiliateId = 56; // Integer | affiliate id
        try {
            AffiliateDashboardUsers result = apiInstance.getDashboardAffiliateUsers(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardAffiliateUsers");
            e.printStackTrace();
        }
    }
}
Integer *affiliateId = 56; // affiliate id

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

// Get affiliate contacts information
[apiInstance getDashboardAffiliateUsersWith:affiliateId
              completionHandler: ^(AffiliateDashboardUsers output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 56; // {Integer} affiliate id


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

namespace Example
{
    public class getDashboardAffiliateUsersExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 56;  // Integer | affiliate id

            try
            {
                // Get affiliate contacts information
                AffiliateDashboardUsers result = apiInstance.getDashboardAffiliateUsers(affiliateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.getDashboardAffiliateUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 56; // Integer | affiliate id

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 56; # Integer | affiliate id

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 56 # Integer | affiliate id

try: 
    # Get affiliate contacts information
    api_response = api_instance.get_dashboard_affiliate_users(affiliateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->getDashboardAffiliateUsers: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Integer (int32)
affiliate id
Required

Responses

Status: 200 -

Status: 400 - Invalid input


getDashboardOffer

Get offer information


/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{offerId}/

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{offerId}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Long offerId = 789; // Long | ID of offer
        try {
            DashboardOffer result = apiInstance.getDashboardOffer(affiliateId, offerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardOffer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Long offerId = 789; // Long | ID of offer
        try {
            DashboardOffer result = apiInstance.getDashboardOffer(affiliateId, offerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#getDashboardOffer");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
Long *offerId = 789; // ID of offer

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

// Get offer information
[apiInstance getDashboardOfferWith:affiliateId
    offerId:offerId
              completionHandler: ^(DashboardOffer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 789; // {Long} ID of affiliate

var offerId = 789; // {Long} ID of offer


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

namespace Example
{
    public class getDashboardOfferExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var offerId = 789;  // Long | ID of offer

            try
            {
                // Get offer information
                DashboardOffer result = apiInstance.getDashboardOffer(affiliateId, offerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.getDashboardOffer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 789; // Long | ID of affiliate
$offerId = 789; // Long | ID of offer

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $offerId = 789; # Long | ID of offer

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 789 # Long | ID of affiliate
offerId = 789 # Long | ID of offer

try: 
    # Get offer information
    api_response = api_instance.get_dashboard_offer(affiliateId, offerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->getDashboardOffer: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
offerId*
Long (int64)
ID of offer
Required

Responses

Status: 200 - Success



performanceReportForAffiliateDashboard

Performance Report For Affiliate Dashboard


/2015-03-01/dashboard/affiliate/{affiliateId}/report/performance

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/report/performance?dateRange=&fields=&format=&filter=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        String dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
        String fields = fields_example; // String | 
        String format = format_example; // String | results format 'json' or 'csv'
        String filter = filter_example; // String | Report Filters - see explanation above

        Integer limit = 56; // Integer | number of records that should be returned
        try {
            AffiliatePerformanceReport result = apiInstance.performanceReportForAffiliateDashboard(affiliateId, dateRange, fields, format, filter, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#performanceReportForAffiliateDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        String dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
        String fields = fields_example; // String | 
        String format = format_example; // String | results format 'json' or 'csv'
        String filter = filter_example; // String | Report Filters - see explanation above

        Integer limit = 56; // Integer | number of records that should be returned
        try {
            AffiliatePerformanceReport result = apiInstance.performanceReportForAffiliateDashboard(affiliateId, dateRange, fields, format, filter, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#performanceReportForAffiliateDashboard");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
String *dateRange = dateRange_example; // date range YYYY-MM-DD-YYYY-MM-DD
String *fields = fields_example; // 
String *format = format_example; // results format 'json' or 'csv' (optional)
String *filter = filter_example; // Report Filters - see explanation above
 (optional)
Integer *limit = 56; // number of records that should be returned (optional)

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

[apiInstance performanceReportForAffiliateDashboardWith:affiliateId
    dateRange:dateRange
    fields:fields
    format:format
    filter:filter
    limit:limit
              completionHandler: ^(AffiliatePerformanceReport output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 789; // {Long} ID of affiliate

var dateRange = dateRange_example; // {String} date range YYYY-MM-DD-YYYY-MM-DD

var fields = fields_example; // {String} 

var opts = { 
  'format': format_example, // {String} results format 'json' or 'csv'
  'filter': filter_example, // {String} Report Filters - see explanation above

  'limit': 56 // {Integer} number of records that should be returned
};

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

namespace Example
{
    public class performanceReportForAffiliateDashboardExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var dateRange = dateRange_example;  // String | date range YYYY-MM-DD-YYYY-MM-DD
            var fields = fields_example;  // String | 
            var format = format_example;  // String | results format 'json' or 'csv' (optional) 
            var filter = filter_example;  // String | Report Filters - see explanation above
 (optional) 
            var limit = 56;  // Integer | number of records that should be returned (optional) 

            try
            {
                AffiliatePerformanceReport result = apiInstance.performanceReportForAffiliateDashboard(affiliateId, dateRange, fields, format, filter, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.performanceReportForAffiliateDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 789; // Long | ID of affiliate
$dateRange = dateRange_example; // String | date range YYYY-MM-DD-YYYY-MM-DD
$fields = fields_example; // String | 
$format = format_example; // String | results format 'json' or 'csv'
$filter = filter_example; // String | Report Filters - see explanation above

$limit = 56; // Integer | number of records that should be returned

try {
    $result = $api_instance->performanceReportForAffiliateDashboard($affiliateId, $dateRange, $fields, $format, $filter, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateDashboardApi->performanceReportForAffiliateDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AffiliateDashboardApi;

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $dateRange = dateRange_example; # String | date range YYYY-MM-DD-YYYY-MM-DD
my $fields = fields_example; # String | 
my $format = format_example; # String | results format 'json' or 'csv'
my $filter = filter_example; # String | Report Filters - see explanation above

my $limit = 56; # Integer | number of records that should be returned

eval { 
    my $result = $api_instance->performanceReportForAffiliateDashboard(affiliateId => $affiliateId, dateRange => $dateRange, fields => $fields, format => $format, filter => $filter, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AffiliateDashboardApi->performanceReportForAffiliateDashboard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 789 # Long | ID of affiliate
dateRange = dateRange_example # String | date range YYYY-MM-DD-YYYY-MM-DD
fields = fields_example # String | 
format = format_example # String | results format 'json' or 'csv' (optional)
filter = filter_example # String | Report Filters - see explanation above
 (optional)
limit = 56 # Integer | number of records that should be returned (optional)

try: 
    api_response = api_instance.performance_report_for_affiliate_dashboard(affiliateId, dateRange, fields, format=format, filter=filter, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->performanceReportForAffiliateDashboard: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
Query parameters
Name Description
dateRange*
String
date range YYYY-MM-DD-YYYY-MM-DD
Required
fields*
String
Required
format
String
results format 'json' or 'csv'
filter
String
Report Filters - see explanation above
limit
Integer (int32)
number of records that should be returned

Responses

Status: 200 - Result of the report. First row will be the headers (columns) and all other rows (if exists) will be the result.

Status: 400 - Invalid input


postDashboardApplyOffer

Apply to offer


/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{offerId}/apply

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{offerId}/apply"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Long offerId = 789; // Long | ID of offer
        try {
            inline_response_200_2 result = apiInstance.postDashboardApplyOffer(affiliateId, offerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#postDashboardApplyOffer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Long offerId = 789; // Long | ID of offer
        try {
            inline_response_200_2 result = apiInstance.postDashboardApplyOffer(affiliateId, offerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#postDashboardApplyOffer");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
Long *offerId = 789; // ID of offer

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

// Apply to offer
[apiInstance postDashboardApplyOfferWith:affiliateId
    offerId:offerId
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 789; // {Long} ID of affiliate

var offerId = 789; // {Long} ID of offer


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

namespace Example
{
    public class postDashboardApplyOfferExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var offerId = 789;  // Long | ID of offer

            try
            {
                // Apply to offer
                inline_response_200_2 result = apiInstance.postDashboardApplyOffer(affiliateId, offerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.postDashboardApplyOffer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 789; // Long | ID of affiliate
$offerId = 789; // Long | ID of offer

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $offerId = 789; # Long | ID of offer

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 789 # Long | ID of affiliate
offerId = 789 # Long | ID of offer

try: 
    # Apply to offer
    api_response = api_instance.post_dashboard_apply_offer(affiliateId, offerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->postDashboardApplyOffer: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
offerId*
Long (int64)
ID of offer
Required

Responses

Status: 200 -

Status: 400 - Invalid input



updateDashboardAffiliateAccount

Update dashboard affiliate


/2015-03-01/dashboard/affiliate/{affiliateId}/account

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/account"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        AffiliateDashboardAccountUpdate payload = ; // AffiliateDashboardAccountUpdate | Updated affiliate data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAffiliateAccount(affiliateId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#updateDashboardAffiliateAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        AffiliateDashboardAccountUpdate payload = ; // AffiliateDashboardAccountUpdate | Updated affiliate data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAffiliateAccount(affiliateId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#updateDashboardAffiliateAccount");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
AffiliateDashboardAccountUpdate *payload = ; // Updated affiliate data

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

// Update dashboard affiliate
[apiInstance updateDashboardAffiliateAccountWith:affiliateId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 789; // {Long} ID of affiliate

var payload = ; // {AffiliateDashboardAccountUpdate} Updated affiliate data


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

namespace Example
{
    public class updateDashboardAffiliateAccountExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var payload = new AffiliateDashboardAccountUpdate(); // AffiliateDashboardAccountUpdate | Updated affiliate data

            try
            {
                // Update dashboard affiliate
                inline_response_200_2 result = apiInstance.updateDashboardAffiliateAccount(affiliateId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.updateDashboardAffiliateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 789; // Long | ID of affiliate
$payload = ; // AffiliateDashboardAccountUpdate | Updated affiliate data

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $payload = WWW::SwaggerClient::Object::AffiliateDashboardAccountUpdate->new(); # AffiliateDashboardAccountUpdate | Updated affiliate data

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 789 # Long | ID of affiliate
payload =  # AffiliateDashboardAccountUpdate | Updated affiliate data

try: 
    # Update dashboard affiliate
    api_response = api_instance.update_dashboard_affiliate_account(affiliateId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->updateDashboardAffiliateAccount: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


updateDashboardAffiliateUsers

Update dashboard contacts


/2015-03-01/dashboard/affiliate/{affiliateId}/users

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        AffiliateDashboardAccountUpdate payload = ; // AffiliateDashboardAccountUpdate | Updated affiliate data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAffiliateUsers(affiliateId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#updateDashboardAffiliateUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        AffiliateDashboardAccountUpdate payload = ; // AffiliateDashboardAccountUpdate | Updated affiliate data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardAffiliateUsers(affiliateId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#updateDashboardAffiliateUsers");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
AffiliateDashboardAccountUpdate *payload = ; // Updated affiliate data

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

// Update dashboard contacts
[apiInstance updateDashboardAffiliateUsersWith:affiliateId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 789; // {Long} ID of affiliate

var payload = ; // {AffiliateDashboardAccountUpdate} Updated affiliate data


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

namespace Example
{
    public class updateDashboardAffiliateUsersExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var payload = new AffiliateDashboardAccountUpdate(); // AffiliateDashboardAccountUpdate | Updated affiliate data

            try
            {
                // Update dashboard contacts
                inline_response_200_2 result = apiInstance.updateDashboardAffiliateUsers(affiliateId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.updateDashboardAffiliateUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 789; // Long | ID of affiliate
$payload = ; // AffiliateDashboardAccountUpdate | Updated affiliate data

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $payload = WWW::SwaggerClient::Object::AffiliateDashboardAccountUpdate->new(); # AffiliateDashboardAccountUpdate | Updated affiliate data

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 789 # Long | ID of affiliate
payload =  # AffiliateDashboardAccountUpdate | Updated affiliate data

try: 
    # Update dashboard contacts
    api_response = api_instance.update_dashboard_affiliate_users(affiliateId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->updateDashboardAffiliateUsers: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


updateDashboardOffer

Update specified offer


/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{offerId}/

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/dashboard/affiliate/{affiliateId}/offers/{offerId}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliateDashboardApi;

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

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Long offerId = 789; // Long | ID of offer
        AffiliateDashboardUpdateOffer payload = ; // AffiliateDashboardUpdateOffer | Updated offer data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardOffer(affiliateId, offerId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#updateDashboardOffer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliateDashboardApi;

public class AffiliateDashboardApiExample {

    public static void main(String[] args) {
        AffiliateDashboardApi apiInstance = new AffiliateDashboardApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Long offerId = 789; // Long | ID of offer
        AffiliateDashboardUpdateOffer payload = ; // AffiliateDashboardUpdateOffer | Updated offer data
        try {
            inline_response_200_2 result = apiInstance.updateDashboardOffer(affiliateId, offerId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliateDashboardApi#updateDashboardOffer");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
Long *offerId = 789; // ID of offer
AffiliateDashboardUpdateOffer *payload = ; // Updated offer data

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

// Update specified offer
[apiInstance updateDashboardOfferWith:affiliateId
    offerId:offerId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliateDashboardApi()

var affiliateId = 789; // {Long} ID of affiliate

var offerId = 789; // {Long} ID of offer

var payload = ; // {AffiliateDashboardUpdateOffer} Updated offer data


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

namespace Example
{
    public class updateDashboardOfferExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliateDashboardApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var offerId = 789;  // Long | ID of offer
            var payload = new AffiliateDashboardUpdateOffer(); // AffiliateDashboardUpdateOffer | Updated offer data

            try
            {
                // Update specified offer
                inline_response_200_2 result = apiInstance.updateDashboardOffer(affiliateId, offerId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliateDashboardApi.updateDashboardOffer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliateDashboardApi();
$affiliateId = 789; // Long | ID of affiliate
$offerId = 789; // Long | ID of offer
$payload = ; // AffiliateDashboardUpdateOffer | Updated offer data

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

my $api_instance = WWW::SwaggerClient::AffiliateDashboardApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $offerId = 789; # Long | ID of offer
my $payload = WWW::SwaggerClient::Object::AffiliateDashboardUpdateOffer->new(); # AffiliateDashboardUpdateOffer | Updated offer data

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

# create an instance of the API class
api_instance = swagger_client.AffiliateDashboardApi()
affiliateId = 789 # Long | ID of affiliate
offerId = 789 # Long | ID of offer
payload =  # AffiliateDashboardUpdateOffer | Updated offer data

try: 
    # Update specified offer
    api_response = api_instance.update_dashboard_offer(affiliateId, offerId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateDashboardApi->updateDashboardOffer: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
offerId*
Long (int64)
ID of offer
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


Affiliates

batchAffiliates

Process bulk operations on affiliates


/2015-03-01/affiliates/batch

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/affiliates/batch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliatesApi;

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

public class AffiliatesApiExample {

    public static void main(String[] args) {
        
        AffiliatesApi apiInstance = new AffiliatesApi();
        Payload payload = ; // Payload | Request data
        try {
            inline_response_200_3 result = apiInstance.batchAffiliates(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#batchAffiliates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliatesApi;

public class AffiliatesApiExample {

    public static void main(String[] args) {
        AffiliatesApi apiInstance = new AffiliatesApi();
        Payload payload = ; // Payload | Request data
        try {
            inline_response_200_3 result = apiInstance.batchAffiliates(payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#batchAffiliates");
            e.printStackTrace();
        }
    }
}
Payload *payload = ; // Request data

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

// Process bulk operations on affiliates
[apiInstance batchAffiliatesWith:payload
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliatesApi()

var payload = ; // {Payload} Request data


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

namespace Example
{
    public class batchAffiliatesExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliatesApi();
            var payload = new Payload(); // Payload | Request data

            try
            {
                // Process bulk operations on affiliates
                inline_response_200_3 result = apiInstance.batchAffiliates(payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliatesApi.batchAffiliates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliatesApi();
$payload = ; // Payload | Request data

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

my $api_instance = WWW::SwaggerClient::AffiliatesApi->new();
my $payload = WWW::SwaggerClient::Object::Payload->new(); # Payload | Request data

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

# create an instance of the API class
api_instance = swagger_client.AffiliatesApi()
payload =  # Payload | Request data

try: 
    # Process bulk operations on affiliates
    api_response = api_instance.batch_affiliates(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliatesApi->batchAffiliates: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 200 -


getAffiliate

Get specified affiliate


/2015-03-01/affiliates/{affiliateId}

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/affiliates/{affiliateId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliatesApi;

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

public class AffiliatesApiExample {

    public static void main(String[] args) {
        
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long affiliateId = 789; // Long | ID of affiliate
        try {
            Affiliate result = apiInstance.getAffiliate(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#getAffiliate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliatesApi;

public class AffiliatesApiExample {

    public static void main(String[] args) {
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long affiliateId = 789; // Long | ID of affiliate
        try {
            Affiliate result = apiInstance.getAffiliate(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#getAffiliate");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate

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

// Get specified affiliate
[apiInstance getAffiliateWith:affiliateId
              completionHandler: ^(Affiliate output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliatesApi()

var affiliateId = 789; // {Long} ID of affiliate


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

namespace Example
{
    public class getAffiliateExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliatesApi();
            var affiliateId = 789;  // Long | ID of affiliate

            try
            {
                // Get specified affiliate
                Affiliate result = apiInstance.getAffiliate(affiliateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliatesApi.getAffiliate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliatesApi();
$affiliateId = 789; // Long | ID of affiliate

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

my $api_instance = WWW::SwaggerClient::AffiliatesApi->new();
my $affiliateId = 789; # Long | ID of affiliate

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

# create an instance of the API class
api_instance = swagger_client.AffiliatesApi()
affiliateId = 789 # Long | ID of affiliate

try: 
    # Get specified affiliate
    api_response = api_instance.get_affiliate(affiliateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliatesApi->getAffiliate: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required

Responses

Status: 200 -

Status: 400 - Invalid input


getAffiliatePossibleOffers

Get a list of offers allowed for application


/2015-03-01/affiliates/{affiliateId}/offers

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/affiliates/{affiliateId}/offers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliatesApi;

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

public class AffiliatesApiExample {

    public static void main(String[] args) {
        
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long affiliateId = 789; // Long | ID of affiliate
        try {
            inline_response_200_4 result = apiInstance.getAffiliatePossibleOffers(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#getAffiliatePossibleOffers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliatesApi;

public class AffiliatesApiExample {

    public static void main(String[] args) {
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long affiliateId = 789; // Long | ID of affiliate
        try {
            inline_response_200_4 result = apiInstance.getAffiliatePossibleOffers(affiliateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#getAffiliatePossibleOffers");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate

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

// Get a list of offers allowed for application
[apiInstance getAffiliatePossibleOffersWith:affiliateId
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliatesApi()

var affiliateId = 789; // {Long} ID of affiliate


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

namespace Example
{
    public class getAffiliatePossibleOffersExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliatesApi();
            var affiliateId = 789;  // Long | ID of affiliate

            try
            {
                // Get a list of offers allowed for application
                inline_response_200_4 result = apiInstance.getAffiliatePossibleOffers(affiliateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliatesApi.getAffiliatePossibleOffers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliatesApi();
$affiliateId = 789; // Long | ID of affiliate

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

my $api_instance = WWW::SwaggerClient::AffiliatesApi->new();
my $affiliateId = 789; # Long | ID of affiliate

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

# create an instance of the API class
api_instance = swagger_client.AffiliatesApi()
affiliateId = 789 # Long | ID of affiliate

try: 
    # Get a list of offers allowed for application
    api_response = api_instance.get_affiliate_possible_offers(affiliateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliatesApi->getAffiliatePossibleOffers: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required

Responses

Status: 200 -



getAffiliates

Get list of affiliates


/2015-03-01/affiliates

Usage and SDK Samples

curl -X GET "http://localhost/2015-03-01/affiliates?id=&start=&rows=&timeframe=&sort=&dir=&format=&name=&accountName=&manager=&salesmanager=&payeeId=&cnt=&referralProgramType=&created=&modified=&modifiedBy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliatesApi;

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

public class AffiliatesApiExample {

    public static void main(String[] args) {
        
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long id = 789; // Long | ID of affiliate
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String timeframe = timeframe_example; // String | affiliate statistics time frame
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | direction of sort 'asce' or 'desc'
        String format = format_example; // String | results format 'json' or 'csv'
        String name = name_example; // String | affiliate name
        String accountName = accountName_example; // String | affiliate name
        String manager = manager_example; // String | affiliate manger email
        String salesmanager = salesmanager_example; // String | affiliate sales manger email
        Integer payeeId = 56; // Integer | payee id
        String cnt = cnt_example; // String | 
        String referralProgramType = referralProgramType_example; // String | one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None'
        String created = created_example; // String | create date range YYYY-MM-DD-YYYY-MM-DD
        String modified = modified_example; // String | modified date range YYYY-MM-DD-YYYY-MM-DD
        String modifiedBy = modifiedBy_example; // String | email of modified user
        try {
            inline_response_200_1 result = apiInstance.getAffiliates(id, start, rows, timeframe, sort, dir, format, name, accountName, manager, salesmanager, payeeId, cnt, referralProgramType, created, modified, modifiedBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#getAffiliates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliatesApi;

public class AffiliatesApiExample {

    public static void main(String[] args) {
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long id = 789; // Long | ID of affiliate
        Integer start = 56; // Integer | to start from
        Integer rows = 56; // Integer | rows count that should be returned
        String timeframe = timeframe_example; // String | affiliate statistics time frame
        String sort = sort_example; // String | field name to sort by
        String dir = dir_example; // String | direction of sort 'asce' or 'desc'
        String format = format_example; // String | results format 'json' or 'csv'
        String name = name_example; // String | affiliate name
        String accountName = accountName_example; // String | affiliate name
        String manager = manager_example; // String | affiliate manger email
        String salesmanager = salesmanager_example; // String | affiliate sales manger email
        Integer payeeId = 56; // Integer | payee id
        String cnt = cnt_example; // String | 
        String referralProgramType = referralProgramType_example; // String | one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None'
        String created = created_example; // String | create date range YYYY-MM-DD-YYYY-MM-DD
        String modified = modified_example; // String | modified date range YYYY-MM-DD-YYYY-MM-DD
        String modifiedBy = modifiedBy_example; // String | email of modified user
        try {
            inline_response_200_1 result = apiInstance.getAffiliates(id, start, rows, timeframe, sort, dir, format, name, accountName, manager, salesmanager, payeeId, cnt, referralProgramType, created, modified, modifiedBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#getAffiliates");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // ID of affiliate (optional)
Integer *start = 56; // to start from (optional)
Integer *rows = 56; // rows count that should be returned (optional)
String *timeframe = timeframe_example; // affiliate statistics time frame (optional)
String *sort = sort_example; // field name to sort by (optional)
String *dir = dir_example; // direction of sort 'asce' or 'desc' (optional)
String *format = format_example; // results format 'json' or 'csv' (optional)
String *name = name_example; // affiliate name (optional)
String *accountName = accountName_example; // affiliate name (optional)
String *manager = manager_example; // affiliate manger email (optional)
String *salesmanager = salesmanager_example; // affiliate sales manger email (optional)
Integer *payeeId = 56; // payee id (optional)
String *cnt = cnt_example; //  (optional)
String *referralProgramType = referralProgramType_example; // one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None' (optional)
String *created = created_example; // create date range YYYY-MM-DD-YYYY-MM-DD (optional)
String *modified = modified_example; // modified date range YYYY-MM-DD-YYYY-MM-DD (optional)
String *modifiedBy = modifiedBy_example; // email of modified user (optional)

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

// Get list of affiliates
[apiInstance getAffiliatesWith:id
    start:start
    rows:rows
    timeframe:timeframe
    sort:sort
    dir:dir
    format:format
    name:name
    accountName:accountName
    manager:manager
    salesmanager:salesmanager
    payeeId:payeeId
    cnt:cnt
    referralProgramType:referralProgramType
    created:created
    modified:modified
    modifiedBy:modifiedBy
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliatesApi()

var opts = { 
  'id': 789, // {Long} ID of affiliate
  'start': 56, // {Integer} to start from
  'rows': 56, // {Integer} rows count that should be returned
  'timeframe': timeframe_example, // {String} affiliate statistics time frame
  'sort': sort_example, // {String} field name to sort by
  'dir': dir_example, // {String} direction of sort 'asce' or 'desc'
  'format': format_example, // {String} results format 'json' or 'csv'
  'name': name_example, // {String} affiliate name
  'accountName': accountName_example, // {String} affiliate name
  'manager': manager_example, // {String} affiliate manger email
  'salesmanager': salesmanager_example, // {String} affiliate sales manger email
  'payeeId': 56, // {Integer} payee id
  'cnt': cnt_example, // {String} 
  'referralProgramType': referralProgramType_example, // {String} one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None'
  'created': created_example, // {String} create date range YYYY-MM-DD-YYYY-MM-DD
  'modified': modified_example, // {String} modified date range YYYY-MM-DD-YYYY-MM-DD
  'modifiedBy': modifiedBy_example // {String} email of modified user
};

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

namespace Example
{
    public class getAffiliatesExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliatesApi();
            var id = 789;  // Long | ID of affiliate (optional) 
            var start = 56;  // Integer | to start from (optional) 
            var rows = 56;  // Integer | rows count that should be returned (optional) 
            var timeframe = timeframe_example;  // String | affiliate statistics time frame (optional) 
            var sort = sort_example;  // String | field name to sort by (optional) 
            var dir = dir_example;  // String | direction of sort 'asce' or 'desc' (optional) 
            var format = format_example;  // String | results format 'json' or 'csv' (optional) 
            var name = name_example;  // String | affiliate name (optional) 
            var accountName = accountName_example;  // String | affiliate name (optional) 
            var manager = manager_example;  // String | affiliate manger email (optional) 
            var salesmanager = salesmanager_example;  // String | affiliate sales manger email (optional) 
            var payeeId = 56;  // Integer | payee id (optional) 
            var cnt = cnt_example;  // String |  (optional) 
            var referralProgramType = referralProgramType_example;  // String | one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None' (optional) 
            var created = created_example;  // String | create date range YYYY-MM-DD-YYYY-MM-DD (optional) 
            var modified = modified_example;  // String | modified date range YYYY-MM-DD-YYYY-MM-DD (optional) 
            var modifiedBy = modifiedBy_example;  // String | email of modified user (optional) 

            try
            {
                // Get list of affiliates
                inline_response_200_1 result = apiInstance.getAffiliates(id, start, rows, timeframe, sort, dir, format, name, accountName, manager, salesmanager, payeeId, cnt, referralProgramType, created, modified, modifiedBy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliatesApi.getAffiliates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliatesApi();
$id = 789; // Long | ID of affiliate
$start = 56; // Integer | to start from
$rows = 56; // Integer | rows count that should be returned
$timeframe = timeframe_example; // String | affiliate statistics time frame
$sort = sort_example; // String | field name to sort by
$dir = dir_example; // String | direction of sort 'asce' or 'desc'
$format = format_example; // String | results format 'json' or 'csv'
$name = name_example; // String | affiliate name
$accountName = accountName_example; // String | affiliate name
$manager = manager_example; // String | affiliate manger email
$salesmanager = salesmanager_example; // String | affiliate sales manger email
$payeeId = 56; // Integer | payee id
$cnt = cnt_example; // String | 
$referralProgramType = referralProgramType_example; // String | one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None'
$created = created_example; // String | create date range YYYY-MM-DD-YYYY-MM-DD
$modified = modified_example; // String | modified date range YYYY-MM-DD-YYYY-MM-DD
$modifiedBy = modifiedBy_example; // String | email of modified user

try {
    $result = $api_instance->getAffiliates($id, $start, $rows, $timeframe, $sort, $dir, $format, $name, $accountName, $manager, $salesmanager, $payeeId, $cnt, $referralProgramType, $created, $modified, $modifiedBy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliatesApi->getAffiliates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AffiliatesApi;

my $api_instance = WWW::SwaggerClient::AffiliatesApi->new();
my $id = 789; # Long | ID of affiliate
my $start = 56; # Integer | to start from
my $rows = 56; # Integer | rows count that should be returned
my $timeframe = timeframe_example; # String | affiliate statistics time frame
my $sort = sort_example; # String | field name to sort by
my $dir = dir_example; # String | direction of sort 'asce' or 'desc'
my $format = format_example; # String | results format 'json' or 'csv'
my $name = name_example; # String | affiliate name
my $accountName = accountName_example; # String | affiliate name
my $manager = manager_example; # String | affiliate manger email
my $salesmanager = salesmanager_example; # String | affiliate sales manger email
my $payeeId = 56; # Integer | payee id
my $cnt = cnt_example; # String | 
my $referralProgramType = referralProgramType_example; # String | one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None'
my $created = created_example; # String | create date range YYYY-MM-DD-YYYY-MM-DD
my $modified = modified_example; # String | modified date range YYYY-MM-DD-YYYY-MM-DD
my $modifiedBy = modifiedBy_example; # String | email of modified user

eval { 
    my $result = $api_instance->getAffiliates(id => $id, start => $start, rows => $rows, timeframe => $timeframe, sort => $sort, dir => $dir, format => $format, name => $name, accountName => $accountName, manager => $manager, salesmanager => $salesmanager, payeeId => $payeeId, cnt => $cnt, referralProgramType => $referralProgramType, created => $created, modified => $modified, modifiedBy => $modifiedBy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AffiliatesApi->getAffiliates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AffiliatesApi()
id = 789 # Long | ID of affiliate (optional)
start = 56 # Integer | to start from (optional)
rows = 56 # Integer | rows count that should be returned (optional)
timeframe = timeframe_example # String | affiliate statistics time frame (optional)
sort = sort_example # String | field name to sort by (optional)
dir = dir_example # String | direction of sort 'asce' or 'desc' (optional)
format = format_example # String | results format 'json' or 'csv' (optional)
name = name_example # String | affiliate name (optional)
accountName = accountName_example # String | affiliate name (optional)
manager = manager_example # String | affiliate manger email (optional)
salesmanager = salesmanager_example # String | affiliate sales manger email (optional)
payeeId = 56 # Integer | payee id (optional)
cnt = cnt_example # String |  (optional)
referralProgramType = referralProgramType_example # String | one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None' (optional)
created = created_example # String | create date range YYYY-MM-DD-YYYY-MM-DD (optional)
modified = modified_example # String | modified date range YYYY-MM-DD-YYYY-MM-DD (optional)
modifiedBy = modifiedBy_example # String | email of modified user (optional)

try: 
    # Get list of affiliates
    api_response = api_instance.get_affiliates(id=id, start=start, rows=rows, timeframe=timeframe, sort=sort, dir=dir, format=format, name=name, accountName=accountName, manager=manager, salesmanager=salesmanager, payeeId=payeeId, cnt=cnt, referralProgramType=referralProgramType, created=created, modified=modified, modifiedBy=modifiedBy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliatesApi->getAffiliates: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
ID of affiliate
start
Integer (int32)
to start from
rows
Integer (int32)
rows count that should be returned
timeframe
String
affiliate statistics time frame
sort
String
field name to sort by
dir
String
direction of sort 'asce' or 'desc'
format
String
results format 'json' or 'csv'
name
String
affiliate name
accountName
String
affiliate name
manager
String
affiliate manger email
salesmanager
String
affiliate sales manger email
payeeId
Integer
payee id
cnt
String
referralProgramType
String
one of 'One-time Payment', 'Percentage From Revenue', 'Percentage From Profit', 'None'
created
String
create date range YYYY-MM-DD-YYYY-MM-DD
modified
String
modified date range YYYY-MM-DD-YYYY-MM-DD
modifiedBy
String
email of modified user

Responses

Status: 200 -

Status: 400 - Invalid input


updateAffiliate

Update specified affiliate


/2015-03-01/affiliates/{affiliateId}

Usage and SDK Samples

curl -X POST "http://localhost/2015-03-01/affiliates/{affiliateId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AffiliatesApi;

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

public class AffiliatesApiExample {

    public static void main(String[] args) {
        
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Affiliate payload = ; // Affiliate | Updated affiliate data
        try {
            inline_response_200_2 result = apiInstance.updateAffiliate(affiliateId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#updateAffiliate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AffiliatesApi;

public class AffiliatesApiExample {

    public static void main(String[] args) {
        AffiliatesApi apiInstance = new AffiliatesApi();
        Long affiliateId = 789; // Long | ID of affiliate
        Affiliate payload = ; // Affiliate | Updated affiliate data
        try {
            inline_response_200_2 result = apiInstance.updateAffiliate(affiliateId, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AffiliatesApi#updateAffiliate");
            e.printStackTrace();
        }
    }
}
Long *affiliateId = 789; // ID of affiliate
Affiliate *payload = ; // Updated affiliate data

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

// Update specified affiliate
[apiInstance updateAffiliateWith:affiliateId
    payload:payload
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AffiliatesApi()

var affiliateId = 789; // {Long} ID of affiliate

var payload = ; // {Affiliate} Updated affiliate data


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

namespace Example
{
    public class updateAffiliateExample
    {
        public void main()
        {
            
            var apiInstance = new AffiliatesApi();
            var affiliateId = 789;  // Long | ID of affiliate
            var payload = new Affiliate(); // Affiliate | Updated affiliate data

            try
            {
                // Update specified affiliate
                inline_response_200_2 result = apiInstance.updateAffiliate(affiliateId, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AffiliatesApi.updateAffiliate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AffiliatesApi();
$affiliateId = 789; // Long | ID of affiliate
$payload = ; // Affiliate | Updated affiliate data

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

my $api_instance = WWW::SwaggerClient::AffiliatesApi->new();
my $affiliateId = 789; # Long | ID of affiliate
my $payload = WWW::SwaggerClient::Object::Affiliate->new(); # Affiliate | Updated affiliate data

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

# create an instance of the API class
api_instance = swagger_client.AffiliatesApi()
affiliateId = 789 # Long | ID of affiliate
payload =  # Affiliate | Updated affiliate data

try: 
    # Update specified affiliate
    api_response = api_instance.update_affiliate(affiliateId, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliatesApi->updateAffiliate: %s\n" % e)

Parameters

Path parameters
Name Description
affiliateId*
Long (int64)
ID of affiliate
Required
Body parameters
Name Description
payload *

Responses

Status: 200 -

Status: 400 - Invalid input


Authentication

auth

Login user


/auth

Usage and SDK Samples

curl -X POST "http://localhost/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        Credentials credentials = ; // Credentials | User credentials
        try {
            inline_response_200 result = apiInstance.auth(credentials);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#auth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        Credentials credentials = ; // Credentials | User credentials
        try {
            inline_response_200 result = apiInstance.auth(credentials);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#auth");
            e.printStackTrace();
        }
    }
}
Credentials *credentials = ; // User credentials

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

// Login user
[apiInstance authWith:credentials
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Echo226EntitiesApi = require('echo226_entities_api');

var api = new Echo226EntitiesApi.AuthenticationApi()

var credentials = ; // {Credentials} User credentials


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

namespace Example
{
    public class authExample
    {
        public void main()
        {
            
            var apiInstance = new AuthenticationApi();
            var credentials = new Credentials(); // Credentials | User credentials

            try
            {
                // Login user
                inline_response_200 result = apiInstance.auth(credentials);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.auth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AuthenticationApi();
$credentials = ; // Credentials | User credentials

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

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $credentials = WWW::SwaggerClient::Object::Credentials->new(); # Credentials | User credentials

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

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
credentials =  # Credentials | User credentials

try: 
    # Login user
    api_response = api_instance.auth(credentials)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->auth: %s\n" % e)

Parameters

Body parameters
Name Description
credentials *