URL Link Shortener API

GetAListOfDomains

v1DomainsGet

Get A list Of Domains


/v1/domains

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/url-link-shortener/v1/domains?active=&limit=&last=&orderBy=&type=&orderDir="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GetAListOfDomainsApi;

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

public class GetAListOfDomainsApiExample {

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

        GetAListOfDomainsApi apiInstance = new GetAListOfDomainsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean active = true; // Boolean | Filter branded domains depending on whether they can be used to brand short links or not
        BigDecimal limit = 8.14; // BigDecimal | How many branded domains to load
        String last = last_example; // String | The id of the last domain you fetched, see Infinite Scrolling section
        String orderBy = orderBy_example; // String | Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName.
        String type = type_example; // String | Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service)
        String orderDir = orderDir_example; // String | Sorting direction to apply to your branded short links collection among desc and asc.
        try {
            Domain result = apiInstance.v1DomainsGet(apiecoKey, active, limit, last, orderBy, type, orderDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GetAListOfDomainsApi#v1DomainsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GetAListOfDomainsApi;

public class GetAListOfDomainsApiExample {

    public static void main(String[] args) {
        GetAListOfDomainsApi apiInstance = new GetAListOfDomainsApi();
        String apiecoKey = apiecoKey_example; // String | 
        Boolean active = true; // Boolean | Filter branded domains depending on whether they can be used to brand short links or not
        BigDecimal limit = 8.14; // BigDecimal | How many branded domains to load
        String last = last_example; // String | The id of the last domain you fetched, see Infinite Scrolling section
        String orderBy = orderBy_example; // String | Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName.
        String type = type_example; // String | Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service)
        String orderDir = orderDir_example; // String | Sorting direction to apply to your branded short links collection among desc and asc.
        try {
            Domain result = apiInstance.v1DomainsGet(apiecoKey, active, limit, last, orderBy, type, orderDir);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GetAListOfDomainsApi#v1DomainsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *apiecoKey = apiecoKey_example; // 
Boolean *active = true; // Filter branded domains depending on whether they can be used to brand short links or not (optional)
BigDecimal *limit = 8.14; // How many branded domains to load (optional)
String *last = last_example; // The id of the last domain you fetched, see Infinite Scrolling section (optional)
String *orderBy = orderBy_example; // Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName. (optional)
String *type = type_example; // Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service) (optional)
String *orderDir = orderDir_example; // Sorting direction to apply to your branded short links collection among desc and asc. (optional)

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

//  Get A list Of Domains
[apiInstance v1DomainsGetWith:apiecoKey
    active:active
    limit:limit
    last:last
    orderBy:orderBy
    type:type
    orderDir:orderDir
              completionHandler: ^(Domain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var UrlLinkShortenerApi_ = require('url_link_shortener_api___');
var defaultClient = UrlLinkShortenerApi_.ApiClient.instance;

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

var api = new UrlLinkShortenerApi_.GetAListOfDomainsApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'active': true, // {Boolean} Filter branded domains depending on whether they can be used to brand short links or not
  'limit': 8.14, // {BigDecimal} How many branded domains to load
  'last': last_example, // {String} The id of the last domain you fetched, see Infinite Scrolling section
  'orderBy': orderBy_example, // {String} Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName.
  'type': type_example, // {String} Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service)
  'orderDir': orderDir_example // {String} Sorting direction to apply to your branded short links collection among desc and asc.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v1DomainsGet(apiecoKey, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GetAListOfDomainsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var active = true;  // Boolean | Filter branded domains depending on whether they can be used to brand short links or not (optional) 
            var limit = 8.14;  // BigDecimal | How many branded domains to load (optional) 
            var last = last_example;  // String | The id of the last domain you fetched, see Infinite Scrolling section (optional) 
            var orderBy = orderBy_example;  // String | Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName. (optional) 
            var type = type_example;  // String | Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service) (optional) 
            var orderDir = orderDir_example;  // String | Sorting direction to apply to your branded short links collection among desc and asc. (optional) 

            try
            {
                //  Get A list Of Domains
                Domain result = apiInstance.v1DomainsGet(apiecoKey, active, limit, last, orderBy, type, orderDir);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GetAListOfDomainsApi.v1DomainsGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\GetAListOfDomainsApi();
$apiecoKey = apiecoKey_example; // String | 
$active = true; // Boolean | Filter branded domains depending on whether they can be used to brand short links or not
$limit = 8.14; // BigDecimal | How many branded domains to load
$last = last_example; // String | The id of the last domain you fetched, see Infinite Scrolling section
$orderBy = orderBy_example; // String | Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName.
$type = type_example; // String | Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service)
$orderDir = orderDir_example; // String | Sorting direction to apply to your branded short links collection among desc and asc.

try {
    $result = $api_instance->v1DomainsGet($apiecoKey, $active, $limit, $last, $orderBy, $type, $orderDir);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GetAListOfDomainsApi->v1DomainsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GetAListOfDomainsApi;

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

my $api_instance = WWW::SwaggerClient::GetAListOfDomainsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $active = true; # Boolean | Filter branded domains depending on whether they can be used to brand short links or not
my $limit = 8.14; # BigDecimal | How many branded domains to load
my $last = last_example; # String | The id of the last domain you fetched, see Infinite Scrolling section
my $orderBy = orderBy_example; # String | Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName.
my $type = type_example; # String | Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service)
my $orderDir = orderDir_example; # String | Sorting direction to apply to your branded short links collection among desc and asc.

eval { 
    my $result = $api_instance->v1DomainsGet(apiecoKey => $apiecoKey, active => $active, limit => $limit, last => $last, orderBy => $orderBy, type => $type, orderDir => $orderDir);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GetAListOfDomainsApi->v1DomainsGet: $@\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: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.GetAListOfDomainsApi()
apiecoKey = apiecoKey_example # String | 
active = true # Boolean | Filter branded domains depending on whether they can be used to brand short links or not (optional)
limit = 8.14 # BigDecimal | How many branded domains to load (optional)
last = last_example # String | The id of the last domain you fetched, see Infinite Scrolling section (optional)
orderBy = orderBy_example # String | Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName. (optional)
type = type_example # String | Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service) (optional)
orderDir = orderDir_example # String | Sorting direction to apply to your branded short links collection among desc and asc. (optional)

try: 
    #  Get A list Of Domains
    api_response = api_instance.v1_domains_get(apiecoKey, active=active, limit=limit, last=last, orderBy=orderBy, type=type, orderDir=orderDir)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GetAListOfDomainsApi->v1DomainsGet: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
active
Boolean
Filter branded domains depending on whether they can be used to brand short links or not
limit
BigDecimal
How many branded domains to load
last
String
The id of the last domain you fetched, see Infinite Scrolling section
orderBy
String
Sorting criteria to apply to your branded domains collection among createdAt, updatedAt and fullName.
type
String
Filter branded domains depending on their type (owned by user, user, or service domains like rebrand.ly, service)
orderDir
String
Sorting direction to apply to your branded short links collection among desc and asc.

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input