AccuWeather (Locations)

AutoComplete

autocompleteSearch

Autocomplete search

Returns basic information about locations matching an autocomplete of the search text.


/cities/autocomplete

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/cities/autocomplete?apikey=&q=&language="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutoCompleteApi;

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

public class AutoCompleteApiExample {

    public static void main(String[] args) {
        
        AutoCompleteApi apiInstance = new AutoCompleteApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | unique id used to search within a specific country
        String q = q_example; // String | Text to use for Autocomplete search.
        String language = language_example; // String | String indicating the language in which to return the resource
        try {
            inline_response_200_3 result = apiInstance.autocompleteSearch(apiecoKey, apikey, countryCode, q, language);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutoCompleteApi#autocompleteSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutoCompleteApi;

public class AutoCompleteApiExample {

    public static void main(String[] args) {
        AutoCompleteApi apiInstance = new AutoCompleteApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | unique id used to search within a specific country
        String q = q_example; // String | Text to use for Autocomplete search.
        String language = language_example; // String | String indicating the language in which to return the resource
        try {
            inline_response_200_3 result = apiInstance.autocompleteSearch(apiecoKey, apikey, countryCode, q, language);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutoCompleteApi#autocompleteSearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // unique id used to search within a specific country
String *q = q_example; // Text to use for Autocomplete search.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)

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

// Autocomplete search
[apiInstance autocompleteSearchWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.AutoCompleteApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} unique id used to search within a specific country

var q = q_example; // {String} Text to use for Autocomplete search.

var opts = { 
  'language': language_example // {String} String indicating the language in which to return the resource
};

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

namespace Example
{
    public class autocompleteSearchExample
    {
        public void main()
        {
            
            var apiInstance = new AutoCompleteApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | unique id used to search within a specific country
            var q = q_example;  // String | Text to use for Autocomplete search.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)

            try
            {
                // Autocomplete search
                inline_response_200_3 result = apiInstance.autocompleteSearch(apiecoKey, apikey, countryCode, q, language);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutoCompleteApi.autocompleteSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AutoCompleteApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | unique id used to search within a specific country
$q = q_example; // String | Text to use for Autocomplete search.
$language = language_example; // String | String indicating the language in which to return the resource

try {
    $result = $api_instance->autocompleteSearch($apiecoKey, $apikey, $countryCode, $q, $language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutoCompleteApi->autocompleteSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutoCompleteApi;

my $api_instance = WWW::SwaggerClient::AutoCompleteApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | unique id used to search within a specific country
my $q = q_example; # String | Text to use for Autocomplete search.
my $language = language_example; # String | String indicating the language in which to return the resource

eval { 
    my $result = $api_instance->autocompleteSearch(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutoCompleteApi->autocompleteSearch: $@\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.AutoCompleteApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | unique id used to search within a specific country
q = q_example # String | Text to use for Autocomplete search.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)

try: 
    # Autocomplete search
    api_response = api_instance.autocomplete_search(apiecoKey, apikey, countryCode, q, language=language)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutoCompleteApi->autocompleteSearch: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
unique id used to search within a specific country
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
q*
String
Text to use for Autocomplete search.
Required
language
String
String indicating the language in which to return the resource

Responses

Status: 200 - Successful


Geoposition

geopositionSearch

Geoposition Search

Returns information about a specific location, by GeoPosition (Latitude and Longitude).


/geoposition/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/geoposition/search?apikey=&language=&details=&toplevel="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GeopositionApi;

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

public class GeopositionApiExample {

    public static void main(String[] args) {
        
        GeopositionApi apiInstance = new GeopositionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Boolean toplevel = true; // Boolean | When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)
        try {
            inline_response_200_4 result = apiInstance.geopositionSearch(apiecoKey, apikey, countryCode, q, language, details, toplevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeopositionApi#geopositionSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeopositionApi;

public class GeopositionApiExample {

    public static void main(String[] args) {
        GeopositionApi apiInstance = new GeopositionApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Boolean toplevel = true; // Boolean | When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)
        try {
            inline_response_200_4 result = apiInstance.geopositionSearch(apiecoKey, apikey, countryCode, q, language, details, toplevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeopositionApi#geopositionSearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Boolean *toplevel = true; // When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.) (optional)

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

// Geoposition Search
[apiInstance geopositionSearchWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
    details:details
    toplevel:toplevel
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.GeopositionApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'toplevel': true // {Boolean} When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)
};

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

namespace Example
{
    public class geopositionSearchExample
    {
        public void main()
        {
            
            var apiInstance = new GeopositionApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var toplevel = true;  // Boolean | When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.) (optional) 

            try
            {
                // Geoposition Search
                inline_response_200_4 result = apiInstance.geopositionSearch(apiecoKey, apikey, countryCode, q, language, details, toplevel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeopositionApi.geopositionSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GeopositionApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$toplevel = true; // Boolean | When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)

try {
    $result = $api_instance->geopositionSearch($apiecoKey, $apikey, $countryCode, $q, $language, $details, $toplevel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeopositionApi->geopositionSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GeopositionApi;

my $api_instance = WWW::SwaggerClient::GeopositionApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $toplevel = true; # Boolean | When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)

eval { 
    my $result = $api_instance->geopositionSearch(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language, details => $details, toplevel => $toplevel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeopositionApi->geopositionSearch: $@\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.GeopositionApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
toplevel = true # Boolean | When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.) (optional)

try: 
    # Geoposition Search
    api_response = api_instance.geoposition_search(apiecoKey, apikey, countryCode, q, language=language, details=details, toplevel=toplevel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeopositionApi->geopositionSearch: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
toplevel
Boolean
When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)

Responses

Status: 200 - Successful


IPAddress

iPAddressSearch

IP Address Search

Returns information about a specific location, by IP Address.


/cities/ipaddress

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/cities/ipaddress?apikey=&language=&details="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IPAddressApi;

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

public class IPAddressApiExample {

    public static void main(String[] args) {
        
        IPAddressApi apiInstance = new IPAddressApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_4 result = apiInstance.iPAddressSearch(apiecoKey, apikey, countryCode, q, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IPAddressApi#iPAddressSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IPAddressApi;

public class IPAddressApiExample {

    public static void main(String[] args) {
        IPAddressApi apiInstance = new IPAddressApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_4 result = apiInstance.iPAddressSearch(apiecoKey, apikey, countryCode, q, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IPAddressApi#iPAddressSearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)

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

// IP Address Search
[apiInstance iPAddressSearchWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
    details:details
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.IPAddressApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true // {Boolean} Boolean value specifies whether or not to include full details in the response.
};

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

namespace Example
{
    public class iPAddressSearchExample
    {
        public void main()
        {
            
            var apiInstance = new IPAddressApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 

            try
            {
                // IP Address Search
                inline_response_200_4 result = apiInstance.iPAddressSearch(apiecoKey, apikey, countryCode, q, language, details);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IPAddressApi.iPAddressSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\IPAddressApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.

try {
    $result = $api_instance->iPAddressSearch($apiecoKey, $apikey, $countryCode, $q, $language, $details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IPAddressApi;

my $api_instance = WWW::SwaggerClient::IPAddressApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.

eval { 
    my $result = $api_instance->iPAddressSearch(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language, details => $details);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IPAddressApi->iPAddressSearch: $@\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.IPAddressApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)

try: 
    # IP Address Search
    api_response = api_instance.i_p_address_search(apiecoKey, apikey, countryCode, q, language=language, details=details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IPAddressApi->iPAddressSearch: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.

Responses

Status: 200 - Successful


List

adminAreaList

Admin Area List

Returns basic information about administrative areas in the specified country.


/adminareas/{countryCode}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/adminareas/{countryCode}?apikey=&language=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListApi;

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

public class ListApiExample {

    public static void main(String[] args) {
        
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | unique id used to search within a specific country
        String language = language_example; // String | String indicating the language in which to return the resource
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        try {
            inline_response_200 result = apiInstance.adminAreaList(apiecoKey, apikey, countryCode, language, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#adminAreaList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListApi;

public class ListApiExample {

    public static void main(String[] args) {
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | unique id used to search within a specific country
        String language = language_example; // String | String indicating the language in which to return the resource
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        try {
            inline_response_200 result = apiInstance.adminAreaList(apiecoKey, apikey, countryCode, language, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#adminAreaList");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // unique id used to search within a specific country
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)

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

// Admin Area List
[apiInstance adminAreaListWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    language:language
    offset:offset
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.ListApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} unique id used to search within a specific country

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'offset': 56 // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
};

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

namespace Example
{
    public class adminAreaListExample
    {
        public void main()
        {
            
            var apiInstance = new ListApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | unique id used to search within a specific country
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 

            try
            {
                // Admin Area List
                inline_response_200 result = apiInstance.adminAreaList(apiecoKey, apikey, countryCode, language, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListApi.adminAreaList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ListApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | unique id used to search within a specific country
$language = language_example; // String | String indicating the language in which to return the resource
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.

try {
    $result = $api_instance->adminAreaList($apiecoKey, $apikey, $countryCode, $language, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->adminAreaList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListApi;

my $api_instance = WWW::SwaggerClient::ListApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | unique id used to search within a specific country
my $language = language_example; # String | String indicating the language in which to return the resource
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.

eval { 
    my $result = $api_instance->adminAreaList(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, language => $language, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListApi->adminAreaList: $@\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.ListApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | unique id used to search within a specific country
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)

try: 
    # Admin Area List
    api_response = api_instance.admin_area_list(apiecoKey, apikey, countryCode, language=language, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListApi->adminAreaList: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
unique id used to search within a specific country
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.

Responses

Status: 200 - Successful


countryList

Country List

Returns basic information about all countries within a specified region.


/countries/{regionCode}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/countries/{regionCode}?apikey=&language="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListApi;

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

public class ListApiExample {

    public static void main(String[] args) {
        
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String regionCode = regionCode_example; // String | unique id used to search within a specific region
        String language = language_example; // String | String indicating the language in which to return the resource
        try {
            inline_response_200_1 result = apiInstance.countryList(apiecoKey, apikey, regionCode, language);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#countryList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListApi;

public class ListApiExample {

    public static void main(String[] args) {
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String regionCode = regionCode_example; // String | unique id used to search within a specific region
        String language = language_example; // String | String indicating the language in which to return the resource
        try {
            inline_response_200_1 result = apiInstance.countryList(apiecoKey, apikey, regionCode, language);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#countryList");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *regionCode = regionCode_example; // unique id used to search within a specific region
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)

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

// Country List
[apiInstance countryListWith:apiecoKey
    apikey:apikey
    regionCode:regionCode
    language:language
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.ListApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var regionCode = regionCode_example; // {String} unique id used to search within a specific region

var opts = { 
  'language': language_example // {String} String indicating the language in which to return the resource
};

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

namespace Example
{
    public class countryListExample
    {
        public void main()
        {
            
            var apiInstance = new ListApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var regionCode = regionCode_example;  // String | unique id used to search within a specific region
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)

            try
            {
                // Country List
                inline_response_200_1 result = apiInstance.countryList(apiecoKey, apikey, regionCode, language);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListApi.countryList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ListApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$regionCode = regionCode_example; // String | unique id used to search within a specific region
$language = language_example; // String | String indicating the language in which to return the resource

try {
    $result = $api_instance->countryList($apiecoKey, $apikey, $regionCode, $language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->countryList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListApi;

my $api_instance = WWW::SwaggerClient::ListApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $regionCode = regionCode_example; # String | unique id used to search within a specific region
my $language = language_example; # String | String indicating the language in which to return the resource

eval { 
    my $result = $api_instance->countryList(apiecoKey => $apiecoKey, apikey => $apikey, regionCode => $regionCode, language => $language);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListApi->countryList: $@\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.ListApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
regionCode = regionCode_example # String | unique id used to search within a specific region
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)

try: 
    # Country List
    api_response = api_instance.country_list(apiecoKey, apikey, regionCode, language=language)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListApi->countryList: %s\n" % e)

Parameters

Path parameters
Name Description
regionCode*
String
unique id used to search within a specific region
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource

Responses

Status: 200 - Successful


regionList

Region List

Returns basic information about all regions.


/regions

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/regions?apikey=&language="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListApi;

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

public class ListApiExample {

    public static void main(String[] args) {
        
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String language = language_example; // String | String indicating the language in which to return the resource
        try {
            inline_response_200_1 result = apiInstance.regionList(apiecoKey, apikey, language);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#regionList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListApi;

public class ListApiExample {

    public static void main(String[] args) {
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String language = language_example; // String | String indicating the language in which to return the resource
        try {
            inline_response_200_1 result = apiInstance.regionList(apiecoKey, apikey, language);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#regionList");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)

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

// Region List
[apiInstance regionListWith:apiecoKey
    apikey:apikey
    language:language
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.ListApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var opts = { 
  'language': language_example // {String} String indicating the language in which to return the resource
};

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

namespace Example
{
    public class regionListExample
    {
        public void main()
        {
            
            var apiInstance = new ListApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)

            try
            {
                // Region List
                inline_response_200_1 result = apiInstance.regionList(apiecoKey, apikey, language);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListApi.regionList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ListApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$language = language_example; // String | String indicating the language in which to return the resource

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

my $api_instance = WWW::SwaggerClient::ListApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $language = language_example; # String | String indicating the language in which to return the resource

eval { 
    my $result = $api_instance->regionList(apiecoKey => $apiecoKey, apikey => $apikey, language => $language);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListApi->regionList: $@\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.ListApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)

try: 
    # Region List
    api_response = api_instance.region_list(apiecoKey, apikey, language=language)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListApi->regionList: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource

Responses

Status: 200 - Successful


topCitiesList

Top Cities List

Returns information for the top 50, 100, or 150 cities, worldwide.


/topcities/{numberOfCities}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/topcities/{numberOfCities}?apikey=&language=&details="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ListApi;

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

public class ListApiExample {

    public static void main(String[] args) {
        
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        BigDecimal numberOfCities = 8.14; // BigDecimal | Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_2 result = apiInstance.topCitiesList(apiecoKey, apikey, numberOfCities, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#topCitiesList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ListApi;

public class ListApiExample {

    public static void main(String[] args) {
        ListApi apiInstance = new ListApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        BigDecimal numberOfCities = 8.14; // BigDecimal | Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_2 result = apiInstance.topCitiesList(apiecoKey, apikey, numberOfCities, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ListApi#topCitiesList");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
BigDecimal *numberOfCities = 8.14; // Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)

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

// Top Cities List
[apiInstance topCitiesListWith:apiecoKey
    apikey:apikey
    numberOfCities:numberOfCities
    language:language
    details:details
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.ListApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var numberOfCities = 8.14; // {BigDecimal} Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true // {Boolean} Boolean value specifies whether or not to include full details in the response.
};

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

namespace Example
{
    public class topCitiesListExample
    {
        public void main()
        {
            
            var apiInstance = new ListApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var numberOfCities = 8.14;  // BigDecimal | Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 

            try
            {
                // Top Cities List
                inline_response_200_2 result = apiInstance.topCitiesList(apiecoKey, apikey, numberOfCities, language, details);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ListApi.topCitiesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ListApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$numberOfCities = 8.14; // BigDecimal | Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.

try {
    $result = $api_instance->topCitiesList($apiecoKey, $apikey, $numberOfCities, $language, $details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->topCitiesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ListApi;

my $api_instance = WWW::SwaggerClient::ListApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $numberOfCities = 8.14; # BigDecimal | Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.

eval { 
    my $result = $api_instance->topCitiesList(apiecoKey => $apiecoKey, apikey => $apikey, numberOfCities => $numberOfCities, language => $language, details => $details);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ListApi->topCitiesList: $@\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.ListApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
numberOfCities = 8.14 # BigDecimal | Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)

try: 
    # Top Cities List
    api_response = api_instance.top_cities_list(apiecoKey, apikey, numberOfCities, language=language, details=details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ListApi->topCitiesList: %s\n" % e)

Parameters

Path parameters
Name Description
numberOfCities*
BigDecimal
Integer that indicates the number of cities to return with the request. Current Supported values are 50, 100 & 150.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.

Responses

Status: 200 - Successful


LocationKey

cityNeighborsByLocationKey

City Neighbors by locationKey

Returns information about neighboring cities, by location key. You must know the location key to perform this query.


/cities/neighbors/{locationKey}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/cities/neighbors/{locationKey}?apikey=&language=&details="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LocationKeyApi;

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

public class LocationKeyApiExample {

    public static void main(String[] args) {
        
        LocationKeyApi apiInstance = new LocationKeyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        BigDecimal locationKey = 8.14; // BigDecimal | unique id used to search for a specific location
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_2 result = apiInstance.cityNeighborsByLocationKey(apiecoKey, apikey, locationKey, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationKeyApi#cityNeighborsByLocationKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LocationKeyApi;

public class LocationKeyApiExample {

    public static void main(String[] args) {
        LocationKeyApi apiInstance = new LocationKeyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        BigDecimal locationKey = 8.14; // BigDecimal | unique id used to search for a specific location
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_2 result = apiInstance.cityNeighborsByLocationKey(apiecoKey, apikey, locationKey, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationKeyApi#cityNeighborsByLocationKey");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
BigDecimal *locationKey = 8.14; // unique id used to search for a specific location
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)

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

// City Neighbors by locationKey
[apiInstance cityNeighborsByLocationKeyWith:apiecoKey
    apikey:apikey
    locationKey:locationKey
    language:language
    details:details
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.LocationKeyApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var locationKey = 8.14; // {BigDecimal} unique id used to search for a specific location

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true // {Boolean} Boolean value specifies whether or not to include full details in the response.
};

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

namespace Example
{
    public class cityNeighborsByLocationKeyExample
    {
        public void main()
        {
            
            var apiInstance = new LocationKeyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var locationKey = 8.14;  // BigDecimal | unique id used to search for a specific location
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 

            try
            {
                // City Neighbors by locationKey
                inline_response_200_2 result = apiInstance.cityNeighborsByLocationKey(apiecoKey, apikey, locationKey, language, details);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocationKeyApi.cityNeighborsByLocationKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LocationKeyApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$locationKey = 8.14; // BigDecimal | unique id used to search for a specific location
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.

try {
    $result = $api_instance->cityNeighborsByLocationKey($apiecoKey, $apikey, $locationKey, $language, $details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationKeyApi->cityNeighborsByLocationKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LocationKeyApi;

my $api_instance = WWW::SwaggerClient::LocationKeyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $locationKey = 8.14; # BigDecimal | unique id used to search for a specific location
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.

eval { 
    my $result = $api_instance->cityNeighborsByLocationKey(apiecoKey => $apiecoKey, apikey => $apikey, locationKey => $locationKey, language => $language, details => $details);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationKeyApi->cityNeighborsByLocationKey: $@\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.LocationKeyApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
locationKey = 8.14 # BigDecimal | unique id used to search for a specific location
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)

try: 
    # City Neighbors by locationKey
    api_response = api_instance.city_neighbors_by_location_key(apiecoKey, apikey, locationKey, language=language, details=details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationKeyApi->cityNeighborsByLocationKey: %s\n" % e)

Parameters

Path parameters
Name Description
locationKey*
BigDecimal
unique id used to search for a specific location
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.

Responses

Status: 200 - Successful


searchByLocationKey

Search by locationKey

RReturns information about a specific location, by location key. You must know the location key to perform this query.


/{locationKey}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/{locationKey}?apikey=&language=&details="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LocationKeyApi;

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

public class LocationKeyApiExample {

    public static void main(String[] args) {
        
        LocationKeyApi apiInstance = new LocationKeyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        BigDecimal locationKey = 8.14; // BigDecimal | unique id used to search for a specific location
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_2 result = apiInstance.searchByLocationKey(apiecoKey, apikey, locationKey, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationKeyApi#searchByLocationKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LocationKeyApi;

public class LocationKeyApiExample {

    public static void main(String[] args) {
        LocationKeyApi apiInstance = new LocationKeyApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        BigDecimal locationKey = 8.14; // BigDecimal | unique id used to search for a specific location
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_2 result = apiInstance.searchByLocationKey(apiecoKey, apikey, locationKey, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationKeyApi#searchByLocationKey");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
BigDecimal *locationKey = 8.14; // unique id used to search for a specific location
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)

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

// Search by locationKey
[apiInstance searchByLocationKeyWith:apiecoKey
    apikey:apikey
    locationKey:locationKey
    language:language
    details:details
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.LocationKeyApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var locationKey = 8.14; // {BigDecimal} unique id used to search for a specific location

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true // {Boolean} Boolean value specifies whether or not to include full details in the response.
};

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

namespace Example
{
    public class searchByLocationKeyExample
    {
        public void main()
        {
            
            var apiInstance = new LocationKeyApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var locationKey = 8.14;  // BigDecimal | unique id used to search for a specific location
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 

            try
            {
                // Search by locationKey
                inline_response_200_2 result = apiInstance.searchByLocationKey(apiecoKey, apikey, locationKey, language, details);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocationKeyApi.searchByLocationKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LocationKeyApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$locationKey = 8.14; // BigDecimal | unique id used to search for a specific location
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.

try {
    $result = $api_instance->searchByLocationKey($apiecoKey, $apikey, $locationKey, $language, $details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationKeyApi->searchByLocationKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LocationKeyApi;

my $api_instance = WWW::SwaggerClient::LocationKeyApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $locationKey = 8.14; # BigDecimal | unique id used to search for a specific location
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.

eval { 
    my $result = $api_instance->searchByLocationKey(apiecoKey => $apiecoKey, apikey => $apikey, locationKey => $locationKey, language => $language, details => $details);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationKeyApi->searchByLocationKey: $@\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.LocationKeyApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
locationKey = 8.14 # BigDecimal | unique id used to search for a specific location
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)

try: 
    # Search by locationKey
    api_response = api_instance.search_by_location_key(apiecoKey, apikey, locationKey, language=language, details=details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationKeyApi->searchByLocationKey: %s\n" % e)

Parameters

Path parameters
Name Description
locationKey*
BigDecimal
unique id used to search for a specific location
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.

Responses

Status: 200 - Successful


TextSearch

citySearch

City Search

Returns information for an array of cities that match the search text.


/cities/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/cities/search?apikey=&q=&language=&details=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.citySearch(apiecoKey, apikey, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#citySearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.citySearch(apiecoKey, apikey, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#citySearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// City Search
[apiInstance citySearchWith:apiecoKey
    apikey:apikey
    q:q
    language:language
    details:details
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class citySearchExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // City Search
                inline_response_200_4 result = apiInstance.citySearch(apiecoKey, apikey, q, language, details, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.citySearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->citySearch($apiecoKey, $apikey, $q, $language, $details, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->citySearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->citySearch(apiecoKey => $apiecoKey, apikey => $apikey, q => $q, language => $language, details => $details, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->citySearch: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # City Search
    api_response = api_instance.city_search(apiecoKey, apikey, q, language=language, details=details, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->citySearch: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
q*
String
Text to search for.
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful


citySearchByCountryAdminCode

City Search

Returns information for an array of cities that match the search text.


/cities/{countryCode}/{adminCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/cities/{countryCode}/{adminCode}/search?apikey=&language=&details=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.citySearchByCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#citySearchByCountryAdminCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.citySearchByCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#citySearchByCountryAdminCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *adminCode = adminCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// City Search
[apiInstance citySearchByCountryAdminCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    adminCode:adminCode
    q:q
    language:language
    details:details
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var adminCode = adminCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class citySearchByCountryAdminCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var adminCode = adminCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // City Search
                inline_response_200_4 result = apiInstance.citySearchByCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.citySearchByCountryAdminCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$adminCode = adminCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->citySearchByCountryAdminCode($apiecoKey, $apikey, $countryCode, $adminCode, $q, $language, $details, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->citySearchByCountryAdminCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $adminCode = adminCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->citySearchByCountryAdminCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, adminCode => $adminCode, q => $q, language => $language, details => $details, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->citySearchByCountryAdminCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
adminCode = adminCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # City Search
    api_response = api_instance.city_search_by_country_admin_code(apiecoKey, apikey, countryCode, adminCode, q, language=language, details=details, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->citySearchByCountryAdminCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
adminCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful


citySearchByCountryCode

City Search

Returns information for an array of cities that match the search text.


/cities/{countryCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/cities/{countryCode}/search?apikey=&language=&details=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.citySearchByCountryCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#citySearchByCountryCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.citySearchByCountryCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#citySearchByCountryCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *adminCode = adminCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// City Search
[apiInstance citySearchByCountryCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    adminCode:adminCode
    q:q
    language:language
    details:details
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var adminCode = adminCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class citySearchByCountryCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var adminCode = adminCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // City Search
                inline_response_200_4 result = apiInstance.citySearchByCountryCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.citySearchByCountryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$adminCode = adminCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->citySearchByCountryCode($apiecoKey, $apikey, $countryCode, $adminCode, $q, $language, $details, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->citySearchByCountryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $adminCode = adminCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->citySearchByCountryCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, adminCode => $adminCode, q => $q, language => $language, details => $details, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->citySearchByCountryCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
adminCode = adminCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # City Search
    api_response = api_instance.city_search_by_country_code(apiecoKey, apikey, countryCode, adminCode, q, language=language, details=details, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->citySearchByCountryCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
adminCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful


pOISearch

POI Search

Returns information for an array of Points of Interest that match the search text.


/poi/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/poi/search?apikey=&language=&details=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        try {
            inline_response_200_4 result = apiInstance.pOISearch(apiecoKey, apikey, q, language, details, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#pOISearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        try {
            inline_response_200_4 result = apiInstance.pOISearch(apiecoKey, apikey, q, language, details, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#pOISearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *type = 56; // POI type ID (optional)

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

// POI Search
[apiInstance pOISearchWith:apiecoKey
    apikey:apikey
    q:q
    language:language
    details:details
    type:type
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'type': 56 // {Integer} POI type ID
};

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

namespace Example
{
    public class pOISearchExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var type = 56;  // Integer | POI type ID (optional) 

            try
            {
                // POI Search
                inline_response_200_4 result = apiInstance.pOISearch(apiecoKey, apikey, q, language, details, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.pOISearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$type = 56; // Integer | POI type ID

try {
    $result = $api_instance->pOISearch($apiecoKey, $apikey, $q, $language, $details, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->pOISearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $type = 56; # Integer | POI type ID

eval { 
    my $result = $api_instance->pOISearch(apiecoKey => $apiecoKey, apikey => $apikey, q => $q, language => $language, details => $details, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->pOISearch: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
type = 56 # Integer | POI type ID (optional)

try: 
    # POI Search
    api_response = api_instance.p_oi_search(apiecoKey, apikey, q, language=language, details=details, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->pOISearch: %s\n" % e)

Parameters

Path parameters
Name Description
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
type
Integer
POI type ID

Responses

Status: 200 - Successful


pOISearchByCountryAdminCode

POI Search (results narrowed by countryCode and adminCode)

Returns information for an array of Points of Interest that match the search text.


/poi/{countryCode}/{adminCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/poi/{countryCode}/{adminCode}/search?apikey=&language=&details=&type=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.pOISearchByCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, type, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#pOISearchByCountryAdminCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.pOISearchByCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, type, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#pOISearchByCountryAdminCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *adminCode = adminCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *type = 56; // POI type ID (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// POI Search (results narrowed by countryCode and adminCode)
[apiInstance pOISearchByCountryAdminCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    adminCode:adminCode
    q:q
    language:language
    details:details
    type:type
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var adminCode = adminCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'type': 56, // {Integer} POI type ID
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class pOISearchByCountryAdminCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var adminCode = adminCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var type = 56;  // Integer | POI type ID (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // POI Search (results narrowed by countryCode and adminCode)
                inline_response_200_4 result = apiInstance.pOISearchByCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, type, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.pOISearchByCountryAdminCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$adminCode = adminCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$type = 56; // Integer | POI type ID
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->pOISearchByCountryAdminCode($apiecoKey, $apikey, $countryCode, $adminCode, $q, $language, $details, $type, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->pOISearchByCountryAdminCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $adminCode = adminCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $type = 56; # Integer | POI type ID
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->pOISearchByCountryAdminCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, adminCode => $adminCode, q => $q, language => $language, details => $details, type => $type, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->pOISearchByCountryAdminCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
adminCode = adminCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
type = 56 # Integer | POI type ID (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # POI Search (results narrowed by countryCode and adminCode)
    api_response = api_instance.p_oi_search_by_country_admin_code(apiecoKey, apikey, countryCode, adminCode, q, language=language, details=details, type=type, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->pOISearchByCountryAdminCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
adminCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
type
Integer
POI type ID
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful


pOISearchByCountryCode

POI Search (results narrowed by countryCode)

Returns information for an array of Points of Interest that match the search text.


/poi/{countryCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/poi/{countryCode}/search?apikey=&language=&details=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        try {
            inline_response_200_4 result = apiInstance.pOISearchByCountryCode(apiecoKey, apikey, countryCode, q, language, details, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#pOISearchByCountryCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        try {
            inline_response_200_4 result = apiInstance.pOISearchByCountryCode(apiecoKey, apikey, countryCode, q, language, details, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#pOISearchByCountryCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *type = 56; // POI type ID (optional)

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

// POI Search (results narrowed by countryCode)
[apiInstance pOISearchByCountryCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
    details:details
    type:type
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'type': 56 // {Integer} POI type ID
};

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

namespace Example
{
    public class pOISearchByCountryCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var type = 56;  // Integer | POI type ID (optional) 

            try
            {
                // POI Search (results narrowed by countryCode)
                inline_response_200_4 result = apiInstance.pOISearchByCountryCode(apiecoKey, apikey, countryCode, q, language, details, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.pOISearchByCountryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$type = 56; // Integer | POI type ID

try {
    $result = $api_instance->pOISearchByCountryCode($apiecoKey, $apikey, $countryCode, $q, $language, $details, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->pOISearchByCountryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $type = 56; # Integer | POI type ID

eval { 
    my $result = $api_instance->pOISearchByCountryCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language, details => $details, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->pOISearchByCountryCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
type = 56 # Integer | POI type ID (optional)

try: 
    # POI Search (results narrowed by countryCode)
    api_response = api_instance.p_oi_search_by_country_code(apiecoKey, apikey, countryCode, q, language=language, details=details, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->pOISearchByCountryCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
type
Integer
POI type ID

Responses

Status: 200 - Successful


postalCodeSearch

Postal Code Search

Returns information for an array of Postal Codes that match the search text.


/postalcodes/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/postalcodes/search?apikey=&language=&details="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_4 result = apiInstance.postalCodeSearch(apiecoKey, apikey, q, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#postalCodeSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_4 result = apiInstance.postalCodeSearch(apiecoKey, apikey, q, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#postalCodeSearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)

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

// Postal Code Search
[apiInstance postalCodeSearchWith:apiecoKey
    apikey:apikey
    q:q
    language:language
    details:details
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true // {Boolean} Boolean value specifies whether or not to include full details in the response.
};

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

namespace Example
{
    public class postalCodeSearchExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 

            try
            {
                // Postal Code Search
                inline_response_200_4 result = apiInstance.postalCodeSearch(apiecoKey, apikey, q, language, details);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.postalCodeSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.

try {
    $result = $api_instance->postalCodeSearch($apiecoKey, $apikey, $q, $language, $details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->postalCodeSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.

eval { 
    my $result = $api_instance->postalCodeSearch(apiecoKey => $apiecoKey, apikey => $apikey, q => $q, language => $language, details => $details);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->postalCodeSearch: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)

try: 
    # Postal Code Search
    api_response = api_instance.postal_code_search(apiecoKey, apikey, q, language=language, details=details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->postalCodeSearch: %s\n" % e)

Parameters

Path parameters
Name Description
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.

Responses

Status: 200 - Successful


postalSearchByCountryCode

Postal Code Search (results narrowed by countryCode)

Returns information for an array of Postal Codes that match the search text.


/postalcodes/{countryCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/postalcodes/{countryCode}/search?apikey=&language=&details="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_4 result = apiInstance.postalSearchByCountryCode(apiecoKey, apikey, countryCode, q, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#postalSearchByCountryCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        try {
            inline_response_200_4 result = apiInstance.postalSearchByCountryCode(apiecoKey, apikey, countryCode, q, language, details);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#postalSearchByCountryCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)

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

// Postal Code Search (results narrowed by countryCode)
[apiInstance postalSearchByCountryCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
    details:details
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true // {Boolean} Boolean value specifies whether or not to include full details in the response.
};

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

namespace Example
{
    public class postalSearchByCountryCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 

            try
            {
                // Postal Code Search (results narrowed by countryCode)
                inline_response_200_4 result = apiInstance.postalSearchByCountryCode(apiecoKey, apikey, countryCode, q, language, details);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.postalSearchByCountryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.

try {
    $result = $api_instance->postalSearchByCountryCode($apiecoKey, $apikey, $countryCode, $q, $language, $details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->postalSearchByCountryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.

eval { 
    my $result = $api_instance->postalSearchByCountryCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language, details => $details);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->postalSearchByCountryCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)

try: 
    # Postal Code Search (results narrowed by countryCode)
    api_response = api_instance.postal_search_by_country_code(apiecoKey, apikey, countryCode, q, language=language, details=details)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->postalSearchByCountryCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.

Responses

Status: 200 - Successful


textSearch

Text Search

Returns information for an array of locations that match the search text.


/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/search?apikey=&language=&details=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.textSearch(apiecoKey, apikey, countryCode, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#textSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.textSearch(apiecoKey, apikey, countryCode, q, language, details, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#textSearch");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// Text Search
[apiInstance textSearchWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
    details:details
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class textSearchExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // Text Search
                inline_response_200_4 result = apiInstance.textSearch(apiecoKey, apikey, countryCode, q, language, details, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.textSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->textSearch($apiecoKey, $apikey, $countryCode, $q, $language, $details, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->textSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->textSearch(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language, details => $details, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->textSearch: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # Text Search
    api_response = api_instance.text_search(apiecoKey, apikey, countryCode, q, language=language, details=details, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->textSearch: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful


textSearchByyCountryAdminCode

Text Search (results narrowed by countryCode and adminCode)

Returns information for an array of locations that match the search text. Results are narrowed by entering a countryCode and adminCode in the path.


/{countryCode}/{adminCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/{countryCode}/{adminCode}/search?apikey=&language=&details=&type=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.textSearchByyCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, type, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#textSearchByyCountryAdminCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String adminCode = adminCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.textSearchByyCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, type, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#textSearchByyCountryAdminCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *adminCode = adminCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *type = 56; // POI type ID (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// Text Search (results narrowed by countryCode and adminCode)
[apiInstance textSearchByyCountryAdminCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    adminCode:adminCode
    q:q
    language:language
    details:details
    type:type
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var adminCode = adminCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'type': 56, // {Integer} POI type ID
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class textSearchByyCountryAdminCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var adminCode = adminCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var type = 56;  // Integer | POI type ID (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // Text Search (results narrowed by countryCode and adminCode)
                inline_response_200_4 result = apiInstance.textSearchByyCountryAdminCode(apiecoKey, apikey, countryCode, adminCode, q, language, details, type, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.textSearchByyCountryAdminCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$adminCode = adminCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$type = 56; // Integer | POI type ID
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->textSearchByyCountryAdminCode($apiecoKey, $apikey, $countryCode, $adminCode, $q, $language, $details, $type, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->textSearchByyCountryAdminCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $adminCode = adminCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $type = 56; # Integer | POI type ID
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->textSearchByyCountryAdminCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, adminCode => $adminCode, q => $q, language => $language, details => $details, type => $type, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->textSearchByyCountryAdminCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
adminCode = adminCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
type = 56 # Integer | POI type ID (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # Text Search (results narrowed by countryCode and adminCode)
    api_response = api_instance.text_search_byy_country_admin_code(apiecoKey, apikey, countryCode, adminCode, q, language=language, details=details, type=type, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->textSearchByyCountryAdminCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
adminCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
type
Integer
POI type ID
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful


textSearchByyCountryCode

Text Search (results narrowed by countryCode)

Returns information for an array of locations that match the search text. Results are narrowed by entering a countryCode in the path.


/{countryCode}/search

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/accuweather-locs/locations/v1/{countryCode}/search?apikey=&language=&details=&type=&offset=&alias="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TextSearchApi;

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

public class TextSearchApiExample {

    public static void main(String[] args) {
        
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.textSearchByyCountryCode(apiecoKey, apikey, countryCode, q, language, details, type, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#textSearchByyCountryCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TextSearchApi;

public class TextSearchApiExample {

    public static void main(String[] args) {
        TextSearchApi apiInstance = new TextSearchApi();
        String apiecoKey = apiecoKey_example; // String | 
        String apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
        String countryCode = countryCode_example; // String | Text to search for.
        String q = q_example; // String | Text to search for.
        String language = language_example; // String | String indicating the language in which to return the resource
        Boolean details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
        Integer type = 56; // Integer | POI type ID
        Integer offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
        String alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
        try {
            inline_response_200_4 result = apiInstance.textSearchByyCountryCode(apiecoKey, apikey, countryCode, q, language, details, type, offset, alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TextSearchApi#textSearchByyCountryCode");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *apikey = apikey_example; // Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
String *countryCode = countryCode_example; // Text to search for.
String *q = q_example; // Text to search for.
String *language = language_example; // String indicating the language in which to return the resource (optional) (default to en-us)
Boolean *details = true; // Boolean value specifies whether or not to include full details in the response. (optional)
Integer *type = 56; // POI type ID (optional)
Integer *offset = 56; // Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
String *alias = alias_example; // Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

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

// Text Search (results narrowed by countryCode)
[apiInstance textSearchByyCountryCodeWith:apiecoKey
    apikey:apikey
    countryCode:countryCode
    q:q
    language:language
    details:details
    type:type
    offset:offset
    alias:alias
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AccuWeatherLocations = require('accu_weather__locations');

var api = new AccuWeatherLocations.TextSearchApi()

var apiecoKey = apiecoKey_example; // {String} 

var apikey = apikey_example; // {String} Provided API Key (Don`t Change The Value)

var countryCode = countryCode_example; // {String} Text to search for.

var q = q_example; // {String} Text to search for.

var opts = { 
  'language': language_example, // {String} String indicating the language in which to return the resource
  'details': true, // {Boolean} Boolean value specifies whether or not to include full details in the response.
  'type': 56, // {Integer} POI type ID
  'offset': 56, // {Integer} Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
  'alias': alias_example // {String} Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always
};

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

namespace Example
{
    public class textSearchByyCountryCodeExample
    {
        public void main()
        {
            
            var apiInstance = new TextSearchApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var apikey = apikey_example;  // String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
            var countryCode = countryCode_example;  // String | Text to search for.
            var q = q_example;  // String | Text to search for.
            var language = language_example;  // String | String indicating the language in which to return the resource (optional)  (default to en-us)
            var details = true;  // Boolean | Boolean value specifies whether or not to include full details in the response. (optional) 
            var type = 56;  // Integer | POI type ID (optional) 
            var offset = 56;  // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional) 
            var alias = alias_example;  // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional)  (default to NoOfficialMatchFound)

            try
            {
                // Text Search (results narrowed by countryCode)
                inline_response_200_4 result = apiInstance.textSearchByyCountryCode(apiecoKey, apikey, countryCode, q, language, details, type, offset, alias);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextSearchApi.textSearchByyCountryCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TextSearchApi();
$apiecoKey = apiecoKey_example; // String | 
$apikey = apikey_example; // String | Provided API Key (Don`t Change The Value)
$countryCode = countryCode_example; // String | Text to search for.
$q = q_example; // String | Text to search for.
$language = language_example; // String | String indicating the language in which to return the resource
$details = true; // Boolean | Boolean value specifies whether or not to include full details in the response.
$type = 56; // Integer | POI type ID
$offset = 56; // Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
$alias = alias_example; // String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

try {
    $result = $api_instance->textSearchByyCountryCode($apiecoKey, $apikey, $countryCode, $q, $language, $details, $type, $offset, $alias);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TextSearchApi->textSearchByyCountryCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TextSearchApi;

my $api_instance = WWW::SwaggerClient::TextSearchApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $apikey = apikey_example; # String | Provided API Key (Don`t Change The Value)
my $countryCode = countryCode_example; # String | Text to search for.
my $q = q_example; # String | Text to search for.
my $language = language_example; # String | String indicating the language in which to return the resource
my $details = true; # Boolean | Boolean value specifies whether or not to include full details in the response.
my $type = 56; # Integer | POI type ID
my $offset = 56; # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
my $alias = alias_example; # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

eval { 
    my $result = $api_instance->textSearchByyCountryCode(apiecoKey => $apiecoKey, apikey => $apikey, countryCode => $countryCode, q => $q, language => $language, details => $details, type => $type, offset => $offset, alias => $alias);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TextSearchApi->textSearchByyCountryCode: $@\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.TextSearchApi()
apiecoKey = apiecoKey_example # String | 
apikey = apikey_example # String | Provided API Key (Don`t Change The Value) (default to WiGNI5bGCbDCeQErSNm0I97azbwEbcKD)
countryCode = countryCode_example # String | Text to search for.
q = q_example # String | Text to search for.
language = language_example # String | String indicating the language in which to return the resource (optional) (default to en-us)
details = true # Boolean | Boolean value specifies whether or not to include full details in the response. (optional)
type = 56 # Integer | POI type ID (optional)
offset = 56 # Integer | Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. (optional)
alias = alias_example # String | Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always (optional) (default to NoOfficialMatchFound)

try: 
    # Text Search (results narrowed by countryCode)
    api_response = api_instance.text_search_byy_country_code(apiecoKey, apikey, countryCode, q, language=language, details=details, type=type, offset=offset, alias=alias)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TextSearchApi->textSearchByyCountryCode: %s\n" % e)

Parameters

Path parameters
Name Description
countryCode*
String
Text to search for.
Required
q*
String
Text to search for.
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
apikey*
String
Provided API Key (Don`t Change The Value)
Required
language
String
String indicating the language in which to return the resource
details
Boolean
Boolean value specifies whether or not to include full details in the response.
type
Integer
POI type ID
offset
Integer
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned.
alias
String
Enumeration that specifies when alias locations should be included in the results. By default, an alias will only be returned if no official match for the search text was found. Enumeration values: Never or Always

Responses

Status: 200 - Successful