allCharacters
All Characters
Fetches lists of comic characters with optional filters.
/characters
Usage and SDK Samples
curl -X GET "https://api.apieco.ir/marvel/v1/public/characters?apikey=&name=&nameStartsWith=&modifiedSince=&comics=&series=&events="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CharactersApi;
import java.io.File;
import java.util.*;
public class CharactersApiExample {
public static void main(String[] args) {
CharactersApi apiInstance = new CharactersApi();
String apiecoKey = apiecoKey_example; // String |
String apikey = apikey_example; // String | Don't Change The Value
String name = name_example; // String | Return only characters matching the specified full character name (e.g. Spider-Man).
String nameStartsWith = nameStartsWith_example; // String | Return characters with names that begin with the specified string (e.g. Sp).
String modifiedSince = modifiedSince_example; // String | Return only characters which have been modified since the specified date.
Integer comics = 56; // Integer | Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
Integer series = 56; // Integer | Return only characters which appear the specified series (accepts a comma-separated list of ids).
Integer events = 56; // Integer | Return only characters which appear in the specified events (accepts a comma-separated list of ids).
try {
inline_response_200 result = apiInstance.allCharacters(apiecoKey, apikey, name, nameStartsWith, modifiedSince, comics, series, events);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CharactersApi#allCharacters");
e.printStackTrace();
}
}
}
import io.swagger.client.api.CharactersApi;
public class CharactersApiExample {
public static void main(String[] args) {
CharactersApi apiInstance = new CharactersApi();
String apiecoKey = apiecoKey_example; // String |
String apikey = apikey_example; // String | Don't Change The Value
String name = name_example; // String | Return only characters matching the specified full character name (e.g. Spider-Man).
String nameStartsWith = nameStartsWith_example; // String | Return characters with names that begin with the specified string (e.g. Sp).
String modifiedSince = modifiedSince_example; // String | Return only characters which have been modified since the specified date.
Integer comics = 56; // Integer | Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
Integer series = 56; // Integer | Return only characters which appear the specified series (accepts a comma-separated list of ids).
Integer events = 56; // Integer | Return only characters which appear in the specified events (accepts a comma-separated list of ids).
try {
inline_response_200 result = apiInstance.allCharacters(apiecoKey, apikey, name, nameStartsWith, modifiedSince, comics, series, events);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CharactersApi#allCharacters");
e.printStackTrace();
}
}
}
String *apiecoKey = apiecoKey_example; //
String *apikey = apikey_example; // Don't Change The Value (default to 7e99dc46d124870a7ddb21c031e462a069f5177d)
String *name = name_example; // Return only characters matching the specified full character name (e.g. Spider-Man). (optional)
String *nameStartsWith = nameStartsWith_example; // Return characters with names that begin with the specified string (e.g. Sp). (optional)
String *modifiedSince = modifiedSince_example; // Return only characters which have been modified since the specified date. (optional)
Integer *comics = 56; // Return only characters which appear in the specified comics (accepts a comma-separated list of ids). (optional)
Integer *series = 56; // Return only characters which appear the specified series (accepts a comma-separated list of ids). (optional)
Integer *events = 56; // Return only characters which appear in the specified events (accepts a comma-separated list of ids). (optional)
CharactersApi *apiInstance = [[CharactersApi alloc] init];
// All Characters
[apiInstance allCharactersWith:apiecoKey
apikey:apikey
name:name
nameStartsWith:nameStartsWith
modifiedSince:modifiedSince
comics:comics
series:series
events:events
completionHandler: ^(inline_response_200 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var MarvelApi = require('marvel_api');
var api = new MarvelApi.CharactersApi()
var apiecoKey = apiecoKey_example; // {String}
var apikey = apikey_example; // {String} Don't Change The Value
var opts = {
'name': name_example, // {String} Return only characters matching the specified full character name (e.g. Spider-Man).
'nameStartsWith': nameStartsWith_example, // {String} Return characters with names that begin with the specified string (e.g. Sp).
'modifiedSince': modifiedSince_example, // {String} Return only characters which have been modified since the specified date.
'comics': 56, // {Integer} Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
'series': 56, // {Integer} Return only characters which appear the specified series (accepts a comma-separated list of ids).
'events': 56 // {Integer} Return only characters which appear in the specified events (accepts a comma-separated list of ids).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.allCharacters(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 allCharactersExample
{
public void main()
{
var apiInstance = new CharactersApi();
var apiecoKey = apiecoKey_example; // String |
var apikey = apikey_example; // String | Don't Change The Value (default to 7e99dc46d124870a7ddb21c031e462a069f5177d)
var name = name_example; // String | Return only characters matching the specified full character name (e.g. Spider-Man). (optional)
var nameStartsWith = nameStartsWith_example; // String | Return characters with names that begin with the specified string (e.g. Sp). (optional)
var modifiedSince = modifiedSince_example; // String | Return only characters which have been modified since the specified date. (optional)
var comics = 56; // Integer | Return only characters which appear in the specified comics (accepts a comma-separated list of ids). (optional)
var series = 56; // Integer | Return only characters which appear the specified series (accepts a comma-separated list of ids). (optional)
var events = 56; // Integer | Return only characters which appear in the specified events (accepts a comma-separated list of ids). (optional)
try
{
// All Characters
inline_response_200 result = apiInstance.allCharacters(apiecoKey, apikey, name, nameStartsWith, modifiedSince, comics, series, events);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling CharactersApi.allCharacters: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\CharactersApi();
$apiecoKey = apiecoKey_example; // String |
$apikey = apikey_example; // String | Don't Change The Value
$name = name_example; // String | Return only characters matching the specified full character name (e.g. Spider-Man).
$nameStartsWith = nameStartsWith_example; // String | Return characters with names that begin with the specified string (e.g. Sp).
$modifiedSince = modifiedSince_example; // String | Return only characters which have been modified since the specified date.
$comics = 56; // Integer | Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
$series = 56; // Integer | Return only characters which appear the specified series (accepts a comma-separated list of ids).
$events = 56; // Integer | Return only characters which appear in the specified events (accepts a comma-separated list of ids).
try {
$result = $api_instance->allCharacters($apiecoKey, $apikey, $name, $nameStartsWith, $modifiedSince, $comics, $series, $events);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CharactersApi->allCharacters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CharactersApi;
my $api_instance = WWW::SwaggerClient::CharactersApi->new();
my $apiecoKey = apiecoKey_example; # String |
my $apikey = apikey_example; # String | Don't Change The Value
my $name = name_example; # String | Return only characters matching the specified full character name (e.g. Spider-Man).
my $nameStartsWith = nameStartsWith_example; # String | Return characters with names that begin with the specified string (e.g. Sp).
my $modifiedSince = modifiedSince_example; # String | Return only characters which have been modified since the specified date.
my $comics = 56; # Integer | Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
my $series = 56; # Integer | Return only characters which appear the specified series (accepts a comma-separated list of ids).
my $events = 56; # Integer | Return only characters which appear in the specified events (accepts a comma-separated list of ids).
eval {
my $result = $api_instance->allCharacters(apiecoKey => $apiecoKey, apikey => $apikey, name => $name, nameStartsWith => $nameStartsWith, modifiedSince => $modifiedSince, comics => $comics, series => $series, events => $events);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CharactersApi->allCharacters: $@\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.CharactersApi()
apiecoKey = apiecoKey_example # String |
apikey = apikey_example # String | Don't Change The Value (default to 7e99dc46d124870a7ddb21c031e462a069f5177d)
name = name_example # String | Return only characters matching the specified full character name (e.g. Spider-Man). (optional)
nameStartsWith = nameStartsWith_example # String | Return characters with names that begin with the specified string (e.g. Sp). (optional)
modifiedSince = modifiedSince_example # String | Return only characters which have been modified since the specified date. (optional)
comics = 56 # Integer | Return only characters which appear in the specified comics (accepts a comma-separated list of ids). (optional)
series = 56 # Integer | Return only characters which appear the specified series (accepts a comma-separated list of ids). (optional)
events = 56 # Integer | Return only characters which appear in the specified events (accepts a comma-separated list of ids). (optional)
try:
# All Characters
api_response = api_instance.all_characters(apiecoKey, apikey, name=name, nameStartsWith=nameStartsWith, modifiedSince=modifiedSince, comics=comics, series=series, events=events)
pprint(api_response)
except ApiException as e:
print("Exception when calling CharactersApi->allCharacters: %s\n" % e)
Parameters
Name | Description |
---|---|
apieco-key* |
String
Required
|
Name | Description |
---|---|
apikey* |
String
Don't Change The Value
Required
|
name |
String
Return only characters matching the specified full character name (e.g. Spider-Man).
|
nameStartsWith |
String
Return characters with names that begin with the specified string (e.g. Sp).
|
modifiedSince |
String
Return only characters which have been modified since the specified date.
|
comics |
Integer
Return only characters which appear in the specified comics (accepts a comma-separated list of ids).
|
series |
Integer
Return only characters which appear the specified series (accepts a comma-separated list of ids).
|
events |
Integer
Return only characters which appear in the specified events (accepts a comma-separated list of ids).
|