getAgents
List agents.
Get a list of agents, paginated response.
/agents
Usage and SDK Samples
curl -X GET\
-H "Accept: application/json"\
"https://api.edgetier.com/agents?limit=&cursor=&external_reference=&email=&order_by=&interaction_start_date_time=&interaction_end_date_time="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;
import java.io.File;
import java.util.*;
public class AgentsApiExample {
public static void main(String[] args) {
AgentsApi apiInstance = new AgentsApi();
Integer limit = 56; // Integer | Number of results to return in each page.
String cursor = cursor_example; // String | Pagination cursor.
String externalReference = externalReference_example; // String | External reference.
String email = email_example; // String | Agent email.
String orderBy = orderBy_example; // String | How to order the results.
Date interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date.
Date interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date.
try {
GetAgents result = apiInstance.getAgents(limit, cursor, externalReference, email, orderBy, interactionStartDateTime, interactionEndDateTime);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AgentsApi#getAgents");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AgentsApi;
public class AgentsApiExample {
public static void main(String[] args) {
AgentsApi apiInstance = new AgentsApi();
Integer limit = 56; // Integer | Number of results to return in each page.
String cursor = cursor_example; // String | Pagination cursor.
String externalReference = externalReference_example; // String | External reference.
String email = email_example; // String | Agent email.
String orderBy = orderBy_example; // String | How to order the results.
Date interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date.
Date interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date.
try {
GetAgents result = apiInstance.getAgents(limit, cursor, externalReference, email, orderBy, interactionStartDateTime, interactionEndDateTime);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AgentsApi#getAgents");
e.printStackTrace();
}
}
}
Integer *limit = 56; // Number of results to return in each page. (optional) (default to 10)
String *cursor = cursor_example; // Pagination cursor. (optional)
String *externalReference = externalReference_example; // External reference. (optional)
String *email = email_example; // Agent email. (optional)
String *orderBy = orderBy_example; // How to order the results. (optional) (default to email.asc)
Date *interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Filter agents that have been active after this date. (optional)
Date *interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Filter agents that have been active before this date. (optional)
AgentsApi *apiInstance = [[AgentsApi alloc] init];
// List agents.
[apiInstance getAgentsWith:limit
cursor:cursor
externalReference:externalReference
email:email
orderBy:orderBy
interactionStartDateTime:interactionStartDateTime
interactionEndDateTime:interactionEndDateTime
completionHandler: ^(GetAgents output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var EdgeTierApiDocument = require('edge_tier_api_document');
var api = new EdgeTierApiDocument.AgentsApi()
var opts = {
'limit': 56, // {{Integer}} Number of results to return in each page.
'cursor': cursor_example, // {{String}} Pagination cursor.
'externalReference': externalReference_example, // {{String}} External reference.
'email': email_example, // {{String}} Agent email.
'orderBy': orderBy_example, // {{String}} How to order the results.
'interactionStartDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} Filter agents that have been active after this date.
'interactionEndDateTime': 2013-10-20T19:20:30+01:00 // {{Date}} Filter agents that have been active before this date.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAgents(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAgentsExample
{
public void main()
{
var apiInstance = new AgentsApi();
var limit = 56; // Integer | Number of results to return in each page. (optional) (default to 10)
var cursor = cursor_example; // String | Pagination cursor. (optional)
var externalReference = externalReference_example; // String | External reference. (optional)
var email = email_example; // String | Agent email. (optional)
var orderBy = orderBy_example; // String | How to order the results. (optional) (default to email.asc)
var interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date. (optional)
var interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date. (optional)
try
{
// List agents.
GetAgents result = apiInstance.getAgents(limit, cursor, externalReference, email, orderBy, interactionStartDateTime, interactionEndDateTime);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AgentsApi.getAgents: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiAgentsApi();
$limit = 56; // Integer | Number of results to return in each page.
$cursor = cursor_example; // String | Pagination cursor.
$externalReference = externalReference_example; // String | External reference.
$email = email_example; // String | Agent email.
$orderBy = orderBy_example; // String | How to order the results.
$interactionStartDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active after this date.
$interactionEndDateTime = 2013-10-20T19:20:30+01:00; // Date | Filter agents that have been active before this date.
try {
$result = $api_instance->getAgents($limit, $cursor, $externalReference, $email, $orderBy, $interactionStartDateTime, $interactionEndDateTime);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AgentsApi->getAgents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentsApi;
my $api_instance = WWW::SwaggerClient::AgentsApi->new();
my $limit = 56; # Integer | Number of results to return in each page.
my $cursor = cursor_example; # String | Pagination cursor.
my $externalReference = externalReference_example; # String | External reference.
my $email = email_example; # String | Agent email.
my $orderBy = orderBy_example; # String | How to order the results.
my $interactionStartDateTime = 2013-10-20T19:20:30+01:00; # Date | Filter agents that have been active after this date.
my $interactionEndDateTime = 2013-10-20T19:20:30+01:00; # Date | Filter agents that have been active before this date.
eval {
my $result = $api_instance->getAgents(limit => $limit, cursor => $cursor, externalReference => $externalReference, email => $email, orderBy => $orderBy, interactionStartDateTime => $interactionStartDateTime, interactionEndDateTime => $interactionEndDateTime);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AgentsApi->getAgents: $@\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.AgentsApi()
limit = 56 # Integer | Number of results to return in each page. (optional) (default to 10)
cursor = cursor_example # String | Pagination cursor. (optional)
externalReference = externalReference_example # String | External reference. (optional)
email = email_example # String | Agent email. (optional)
orderBy = orderBy_example # String | How to order the results. (optional) (default to email.asc)
interactionStartDateTime = 2013-10-20T19:20:30+01:00 # Date | Filter agents that have been active after this date. (optional)
interactionEndDateTime = 2013-10-20T19:20:30+01:00 # Date | Filter agents that have been active before this date. (optional)
try:
# List agents.
api_response = api_instance.get_agents(limit=limit, cursor=cursor, externalReference=externalReference, email=email, orderBy=orderBy, interactionStartDateTime=interactionStartDateTime, interactionEndDateTime=interactionEndDateTime)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentsApi->getAgents: %s\n" % e)
Parameters
Query parameters
Name | Description |
---|---|
limit |
Integer
Number of results to return in each page.
|
cursor |
String
Pagination cursor.
|
external_reference |
String
External reference.
|
String
Agent email.
|
|
order_by |
String
How to order the results.
|
interaction_start_date_time |
Date
(date-time)
Filter agents that have been active after this date.
|
interaction_end_date_time |
Date
(date-time)
Filter agents that have been active before this date.
|