getAddresses
This function returns all addresses in your account. If you provide a companyID, system will only return the addresses registered for that company. Else, it will return all addresses in the account.
/addresses
Usage and SDK Samples
curl -X GET -H "x-api-key: [[apiKey]]" "https://30fo61e8a3.execute-api.eu-west-1.amazonaws.com/Production/addresses"import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;
import java.io.File;
import java.util.*;
public class AddressesApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
AddressesApi apiInstance = new AddressesApi();
String userID = userID_example; // String |
String companyID = companyID_example; // String |
String xApiKey = xApiKey_example; // String |
try {
AddressesResponse result = apiInstance.getAddresses(userID, companyID, xApiKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AddressesApi#getAddresses");
e.printStackTrace();
}
}
}import io.swagger.client.api.AddressesApi;
public class AddressesApiExample {
public static void main(String[] args) {
AddressesApi apiInstance = new AddressesApi();
String userID = userID_example; // String |
String companyID = companyID_example; // String |
String xApiKey = xApiKey_example; // String |
try {
AddressesResponse result = apiInstance.getAddresses(userID, companyID, xApiKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AddressesApi#getAddresses");
e.printStackTrace();
}
}
}Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
String *userID = userID_example; //
String *companyID = companyID_example; //
String *xApiKey = xApiKey_example; //
AddressesApi *apiInstance = [[AddressesApi alloc] init];
[apiInstance getAddressesWith:userID
companyID:companyID
xApiKey:xApiKey
completionHandler: ^(AddressesResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var Jetract = require('jetract');
var defaultClient = Jetract.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"
var api = new Jetract.AddressesApi()
var userID = userID_example; // {String}
var companyID = companyID_example; // {String}
var xApiKey = xApiKey_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAddresses(userID, companyID, xApiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAddressesExample
{
public void main()
{
// Configure API key authorization: api_key
Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");
var apiInstance = new AddressesApi();
var userID = userID_example; // String |
var companyID = companyID_example; // String |
var xApiKey = xApiKey_example; // String |
try
{
AddressesResponse result = apiInstance.getAddresses(userID, companyID, xApiKey);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AddressesApi.getAddresses: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$api_instance = new Swagger\Client\Api\AddressesApi();
$userID = userID_example; // String |
$companyID = companyID_example; // String |
$xApiKey = xApiKey_example; // String |
try {
$result = $api_instance->getAddresses($userID, $companyID, $xApiKey);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressesApi->getAddresses: ', $e->getMessage(), PHP_EOL;
}
?>use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressesApi;
# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";
my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $userID = userID_example; # String |
my $companyID = companyID_example; # String |
my $xApiKey = xApiKey_example; # String |
eval {
my $result = $api_instance->getAddresses(userID => $userID, companyID => $companyID, xApiKey => $xApiKey);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AddressesApi->getAddresses: $@\n";
}from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.AddressesApi()
userID = userID_example # String |
companyID = companyID_example # String |
xApiKey = xApiKey_example # String |
try:
api_response = api_instance.get_addresses(userID, companyID, xApiKey)
pprint(api_response)
except ApiException as e:
print("Exception when calling AddressesApi->getAddresses: %s\n" % e)Parameters
Header parameters
| Name | Description |
|---|---|
| userID* |
String
Required
|
| companyID* |
String
Required
|
| x-api-key* |
String
Required
|