Marvel.Api.MarvelRestClient Class Reference

REST API wrapper. More...

Inheritance diagram for Marvel.Api.MarvelRestClient:

Public Member Functions
virtual CharacterResult	FindCharacters (CharacterRequestFilter filter=default(CharacterRequestFilter))
	Fetches lists of comic characters with optional filters. More...
virtual CharacterResult	FindCharacter (string characterId)
	This method fetches a single character resource. It is the canonical URI for any character resource provided by the API. More...
virtual ComicResult	FindCharacterComics (string characterId, ComicRequestFilter filter=default(ComicRequestFilter))
	Fetches lists of comics containing a specific character, with optional filters. More...
virtual EventResult	FindCharacterEvents (string characterId, EventRequestFilter filter=default(EventRequestFilter))
	Fetches lists of events in which a specific character appears, with optional filters. More...
virtual SeriesResult	FindCharacterSeries (string characterId, SeriesRequestFilter filter=default(SeriesRequestFilter))
	Fetches lists of comic series in which a specific character appears, with optional filters. More...
virtual StoryResult	FindCharacterStories (string characterId, StoryRequestFilter filter=default(StoryRequestFilter))
	Fetches lists of comic stories featuring a specific character with optional filters. More...
virtual ComicResult	FindComics (ComicRequestFilter filter=default(ComicRequestFilter))
	Fetches lists of comics with optional filters. More...
virtual ComicResult	FindComic (string comicId)
	This method fetches a single comic resource. It is the canonical URI for any comic resource provided by the API. More...
virtual CreatorResult	FindComicCreators (string comicId, CreatorRequestFilter filter=default(CreatorRequestFilter))
	Fetches lists of comic creators whose work appears in a specific comic, with optional filters. More...
virtual CharacterResult	FindComicCharacters (string comicId, CharacterRequestFilter filter=default(CharacterRequestFilter))
	Fetches lists of characters which appear in a specific comic with optional filters. More...
virtual EventResult	FindComicEvents (string comicId, EventRequestFilter filter=default(EventRequestFilter))
	Fetches lists of events in which a specific comic appears, with optional filters. More...
virtual StoryResult	FindComicStories (string comicId, StoryRequestFilter filter=default(StoryRequestFilter))
	Fetches lists of comic stories in a specific comic issue, with optional filters. More...
	MarvelRestClient (string apiPublicKey, string apiPrivateKey)
	Initializes a new client with the specified credentials More...
virtual CreatorResult	FindCreators (CreatorRequestFilter filter=default(CreatorRequestFilter))
	Fetches lists of comic creators with optional filters. More...
virtual CreatorResult	FindCreator (string creatorId)
	This method fetches a single creator resource. It is the canonical URI for any creator resource provided by the API. More...
virtual ComicResult	FindCreatorComics (string creatorId, ComicRequestFilter filter=default(ComicRequestFilter))
	Fetches lists of comics in which the work of a specific creator appears, with optional filters. More...
virtual EventResult	FindCreatorEvents (string creatorId, EventRequestFilter filter=default(EventRequestFilter))
	Fetches lists of events featuring the work of a specific creator with optional filters. More...
virtual SeriesResult	FindCreatorSeries (string creatorId, SeriesRequestFilter filter=default(SeriesRequestFilter))
	Fetches lists of comic series in which a specific creator's work appears, with optional filters. More...
virtual StoryResult	FindCreatorStories (string creatorId, StoryRequestFilter filter=default(StoryRequestFilter))
	Fetches lists of comic stories by a specific creator with optional filters. More...
virtual EventResult	FindEvents (EventRequestFilter filter=default(EventRequestFilter))
	Fetches lists of events with optional filters. More...
virtual EventResult	FindEvent (string eventId)
	This method fetches a single event resource. It is the canonical URI for any event resource provided by the API. More...
virtual CharacterResult	FindEventCharacters (string eventId, CharacterRequestFilter filter=default(CharacterRequestFilter))
	Fetches lists of characters which appear in a specific event, with optional filters. More...
virtual ComicResult	FindEventComics (string eventId, ComicRequestFilter filter=default(ComicRequestFilter))
	Fetches lists of comics which take place during a specific event, with optional filters. More...
virtual CreatorResult	FindEventCreators (string eventId, CreatorRequestFilter filter=default(CreatorRequestFilter))
	Fetches lists of comic creators whose work appears in a specific event, with optional filters. More...
virtual SeriesResult	FindEventSeries (string eventId, SeriesRequestFilter filter=default(SeriesRequestFilter))
	Fetches lists of comic series in which a specific event takes place, with optional filters. More...
virtual StoryResult	FindEventStories (string eventId, StoryRequestFilter filter=default(StoryRequestFilter))
	Fetches lists of comic stories from a specific event, with optional filters. More...
virtual SeriesResult	FindSeries (SeriesRequestFilter filter=default(SeriesRequestFilter))
	Fetches lists of comic series with optional filters. More...
virtual SeriesResult	FindSeries (string seriesId)
	This method fetches a single comic series resource. It is the canonical URI for any comic series resource provided by the API. More...
virtual CharacterResult	FindSeriesCharacters (string seriesId, CharacterRequestFilter filter=default(CharacterRequestFilter))
	Fetches lists of characters which appear in specific series, with optional filters. More...
virtual ComicResult	FindSeriesComics (string seriesId, ComicRequestFilter filter=default(ComicRequestFilter))
	Fetches lists of comics which are published as part of a specific series, with optional filters. More...
virtual CreatorResult	FindSeriesCreators (string seriesId, CreatorRequestFilter filter=default(CreatorRequestFilter))
	Fetches lists of comic creators whose work appears in a specific series, with optional filters. More...
virtual EventResult	FindSeriesEvents (string seriesId, EventRequestFilter filter=default(EventRequestFilter))
	Fetches lists of events which occur in a specific series, with optional filters. More...
virtual StoryResult	FindSeriesStories (string seriesId, StoryRequestFilter filter=default(StoryRequestFilter))
	Fetches lists of comic stories from a specific series with optional filters. More...
virtual StoryResult	FindStories (StoryRequestFilter filter=default(StoryRequestFilter))
	Fetches lists of comic stories with optional filters. More...
virtual StoryResult	FindStory (string storyId)
	This method fetches a single comic story resource. It is the canonical URI for any comic story resource provided by the API. More...
virtual CharacterResult	FindStoryCharacters (string storyId, CharacterRequestFilter filter=default(CharacterRequestFilter))
	Fetches lists of comic characters appearing in a single story, with optional filters. More...
virtual ComicResult	FindStoryComics (string storyId, ComicRequestFilter filter=default(ComicRequestFilter))
	Fetches lists of comics in which a specific story appears, with optional filters. More...
virtual CreatorResult	FindStoryCreators (string storyId, CreatorRequestFilter filter=default(CreatorRequestFilter))
	Fetches lists of comic creators whose work appears in a specific story, with optional filters. More...
virtual EventResult	FindStoryEvents (string storyId, EventRequestFilter filter=default(EventRequestFilter))
	Fetches lists of events in which a specific story appears, with optional filters. More...
virtual SeriesResult	FindStorySeries (string storyId, SeriesRequestFilter filter=default(SeriesRequestFilter))
	Fetches lists of comic series in which the specified story takes place. More...
Public Member Functions inherited from Marvel.Api.MarvelClient
virtual void	ExecuteAsync< T > (IRestRequest request, Action< T > callback)
	Execute a manual REST request More...
virtual void	ExecuteAsync (IRestRequest request, Action< IRestResponse > callback)
	Execute a manual REST request More...
virtual T	Execute< T > (IRestRequest request)
	Execute a manual REST request More...
virtual IRestResponse	Execute (IRestRequest request)
	Execute a manual REST request More...

Additional Inherited Members
Protected Member Functions inherited from Marvel.Api.MarvelClient
	MarvelClient (string apiPublicKey, string apiPrivateKey, string apiVersion, string baseUrl)
Protected Attributes inherited from Marvel.Api.MarvelClient
RestClient	Client
readonly string	ApiPublicKey
readonly string	ApiPrivateKey
Properties inherited from Marvel.Api.MarvelClient
string	BaseUrl [get]
	Base URL of API More...
string	ApiVersion [get]
	Marvel API version to use when making requests More...
string	DateFormat [get, set]

Detailed Description

REST API wrapper.

Definition at line 7 of file Characters.cs.

Constructor & Destructor Documentation

Marvel.Api.MarvelRestClient.MarvelRestClient	(	string	apiPublicKey,
		string	apiPrivateKey
	)

Initializes a new client with the specified credentials

Parameters

apiPublicKey	API public key
apiPrivateKey	API private key

Definition at line 145 of file Core.cs.

Member Function Documentation

virtual CharacterResult Marvel.Api.MarvelRestClient.FindCharacter ( string  characterId )

virtual

This method fetches a single character resource. It is the canonical URI for any character resource provided by the API.

Parameters

characterId

Character unique identifier

Definition at line 35 of file Characters.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindCharacterComics ( string  characterId, ComicRequestFilter  filter = default(ComicRequestFilter)  )

virtual

Fetches lists of comics containing a specific character, with optional filters.

Parameters

characterId	Character unique identifier
filter	Search query filter data

Definition at line 57 of file Characters.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindCharacterEvents ( string  characterId, EventRequestFilter  filter = default(EventRequestFilter)  )

virtual

Fetches lists of events in which a specific character appears, with optional filters.

Parameters

characterId	Character unique identifier
filter	Search query filter data

Definition at line 83 of file Characters.cs.

virtual CharacterResult Marvel.Api.MarvelRestClient.FindCharacters ( CharacterRequestFilter  filter = default(CharacterRequestFilter) )

virtual

Fetches lists of comic characters with optional filters.

Parameters

filter

Search query filter data

Definition at line 17 of file Characters.cs.

virtual SeriesResult Marvel.Api.MarvelRestClient.FindCharacterSeries ( string  characterId, SeriesRequestFilter  filter = default(SeriesRequestFilter)  )

virtual

Fetches lists of comic series in which a specific character appears, with optional filters.

Parameters

characterId	Character unique identifier
filter	Search query filter data

Definition at line 109 of file Characters.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindCharacterStories ( string  characterId, StoryRequestFilter  filter = default(StoryRequestFilter)  )

virtual

Fetches lists of comic stories featuring a specific character with optional filters.

Parameters

characterId	Character unique identifier
filter	Search query filter data

Definition at line 134 of file Characters.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindComic ( string  comicId )

virtual

This method fetches a single comic resource. It is the canonical URI for any comic resource provided by the API.

Parameters

comicId

Comic unique identifier

Definition at line 35 of file Comics.cs.

virtual CharacterResult Marvel.Api.MarvelRestClient.FindComicCharacters ( string  comicId, CharacterRequestFilter  filter = default(CharacterRequestFilter)  )

virtual

Fetches lists of characters which appear in a specific comic with optional filters.

Parameters

comicId	Comic unique identifier
filter	Search query filter data

Definition at line 82 of file Comics.cs.

virtual CreatorResult Marvel.Api.MarvelRestClient.FindComicCreators ( string  comicId, CreatorRequestFilter  filter = default(CreatorRequestFilter)  )

virtual

Fetches lists of comic creators whose work appears in a specific comic, with optional filters.

Parameters

comicId	Comic unique identifier
filter	Search query filter data

Definition at line 57 of file Comics.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindComicEvents ( string  comicId, EventRequestFilter  filter = default(EventRequestFilter)  )

virtual

Fetches lists of events in which a specific comic appears, with optional filters.

Parameters

comicId	Comic unique identifier
filter	Search query filter data

Definition at line 108 of file Comics.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindComics ( ComicRequestFilter  filter = default(ComicRequestFilter) )

virtual

Fetches lists of comics with optional filters.

Parameters

filter

Search query filter data

Definition at line 17 of file Comics.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindComicStories ( string  comicId, StoryRequestFilter  filter = default(StoryRequestFilter)  )

virtual

Fetches lists of comic stories in a specific comic issue, with optional filters.

Parameters

comicId	Comic unique identifier
filter	Search query filter data

Definition at line 133 of file Comics.cs.

virtual CreatorResult Marvel.Api.MarvelRestClient.FindCreator ( string  creatorId )

virtual

This method fetches a single creator resource. It is the canonical URI for any creator resource provided by the API.

Parameters

creatorId

Creator unique identifier

Definition at line 35 of file Creators.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindCreatorComics ( string  creatorId, ComicRequestFilter  filter = default(ComicRequestFilter)  )

virtual

Fetches lists of comics in which the work of a specific creator appears, with optional filters.

Parameters

creatorId	Creator unique identifier
filter	Search query filter data

Definition at line 57 of file Creators.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindCreatorEvents ( string  creatorId, EventRequestFilter  filter = default(EventRequestFilter)  )

virtual

Fetches lists of events featuring the work of a specific creator with optional filters.

Parameters

creatorId	Creator unique identifier
filter	Search query filter data

Definition at line 82 of file Creators.cs.

virtual CreatorResult Marvel.Api.MarvelRestClient.FindCreators ( CreatorRequestFilter  filter = default(CreatorRequestFilter) )

virtual

Fetches lists of comic creators with optional filters.

Parameters

filter

Search query filter data

Definition at line 17 of file Creators.cs.

virtual SeriesResult Marvel.Api.MarvelRestClient.FindCreatorSeries ( string  creatorId, SeriesRequestFilter  filter = default(SeriesRequestFilter)  )

virtual

Fetches lists of comic series in which a specific creator's work appears, with optional filters.

Parameters

creatorId	Creator unique identifier
filter	Search query filter data

Definition at line 108 of file Creators.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindCreatorStories ( string  creatorId, StoryRequestFilter  filter = default(StoryRequestFilter)  )

virtual

Fetches lists of comic stories by a specific creator with optional filters.

Parameters

creatorId	Creator unique identifier
filter	Search query filter data

Definition at line 133 of file Creators.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindEvent ( string  eventId )

virtual

This method fetches a single event resource. It is the canonical URI for any event resource provided by the API.

Parameters

eventId

Event unique identifier

Definition at line 35 of file Events.cs.

virtual CharacterResult Marvel.Api.MarvelRestClient.FindEventCharacters ( string  eventId, CharacterRequestFilter  filter = default(CharacterRequestFilter)  )

virtual

Fetches lists of characters which appear in a specific event, with optional filters.

Parameters

eventId	Event unique identifier
filter	Search query filter data

Definition at line 57 of file Events.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindEventComics ( string  eventId, ComicRequestFilter  filter = default(ComicRequestFilter)  )

virtual

Fetches lists of comics which take place during a specific event, with optional filters.

Parameters

eventId	Event unique identifier
filter	Search query filter data

Definition at line 83 of file Events.cs.

virtual CreatorResult Marvel.Api.MarvelRestClient.FindEventCreators ( string  eventId, CreatorRequestFilter  filter = default(CreatorRequestFilter)  )

virtual

Fetches lists of comic creators whose work appears in a specific event, with optional filters.

Parameters

eventId	Event unique identifier
filter	Search query filter data

Definition at line 109 of file Events.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindEvents ( EventRequestFilter  filter = default(EventRequestFilter) )

virtual

Fetches lists of events with optional filters.

Parameters

filter

Search query filter data

Definition at line 17 of file Events.cs.

virtual SeriesResult Marvel.Api.MarvelRestClient.FindEventSeries ( string  eventId, SeriesRequestFilter  filter = default(SeriesRequestFilter)  )

virtual

Fetches lists of comic series in which a specific event takes place, with optional filters.

Parameters

eventId	Event unique identifier
filter	Search query filter data

Definition at line 135 of file Events.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindEventStories ( string  eventId, StoryRequestFilter  filter = default(StoryRequestFilter)  )

virtual

Fetches lists of comic stories from a specific event, with optional filters.

Parameters

eventId	Event unique identifier
filter	Search query filter data

Definition at line 161 of file Events.cs.

virtual SeriesResult Marvel.Api.MarvelRestClient.FindSeries ( SeriesRequestFilter  filter = default(SeriesRequestFilter) )

virtual

Fetches lists of comic series with optional filters.

Parameters

filter

Search query filter data

Definition at line 17 of file Series.cs.

virtual SeriesResult Marvel.Api.MarvelRestClient.FindSeries ( string  seriesId )

virtual

This method fetches a single comic series resource. It is the canonical URI for any comic series resource provided by the API.

Parameters

seriesId

Series unique identifier

Definition at line 35 of file Series.cs.

virtual CharacterResult Marvel.Api.MarvelRestClient.FindSeriesCharacters ( string  seriesId, CharacterRequestFilter  filter = default(CharacterRequestFilter)  )

virtual

Fetches lists of characters which appear in specific series, with optional filters.

Parameters

seriesId	Series unique identifier
filter	Search query filter data

Definition at line 57 of file Series.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindSeriesComics ( string  seriesId, ComicRequestFilter  filter = default(ComicRequestFilter)  )

virtual

Fetches lists of comics which are published as part of a specific series, with optional filters.

Parameters

seriesId	Series unique identifier
filter	Search query filter data

Definition at line 83 of file Series.cs.

virtual CreatorResult Marvel.Api.MarvelRestClient.FindSeriesCreators ( string  seriesId, CreatorRequestFilter  filter = default(CreatorRequestFilter)  )

virtual

Fetches lists of comic creators whose work appears in a specific series, with optional filters.

Parameters

seriesId	Series unique identifier
filter	Search query filter data

Definition at line 109 of file Series.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindSeriesEvents ( string  seriesId, EventRequestFilter  filter = default(EventRequestFilter)  )

virtual

Fetches lists of events which occur in a specific series, with optional filters.

Parameters

seriesId	Series unique identifier
filter	Search query filter data

Definition at line 135 of file Series.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindSeriesStories ( string  seriesId, StoryRequestFilter  filter = default(StoryRequestFilter)  )

virtual

Fetches lists of comic stories from a specific series with optional filters.

Parameters

seriesId	Series unique identifier
filter	Search query filter data

Definition at line 160 of file Series.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindStories ( StoryRequestFilter  filter = default(StoryRequestFilter) )

virtual

Fetches lists of comic stories with optional filters.

Parameters

filter

Search query filter data

Definition at line 17 of file Stories.cs.

virtual StoryResult Marvel.Api.MarvelRestClient.FindStory ( string  storyId )

virtual

This method fetches a single comic story resource. It is the canonical URI for any comic story resource provided by the API.

Parameters

storyId

Story unique identifier

Definition at line 35 of file Stories.cs.

virtual CharacterResult Marvel.Api.MarvelRestClient.FindStoryCharacters ( string  storyId, CharacterRequestFilter  filter = default(CharacterRequestFilter)  )

virtual

Fetches lists of comic characters appearing in a single story, with optional filters.

Parameters

storyId	Story unique identifier
filter	Search query filter data

Definition at line 57 of file Stories.cs.

virtual ComicResult Marvel.Api.MarvelRestClient.FindStoryComics ( string  storyId, ComicRequestFilter  filter = default(ComicRequestFilter)  )

virtual

Fetches lists of comics in which a specific story appears, with optional filters.

Parameters

storyId	Story unique identifier
filter	Search query filter data

Definition at line 83 of file Stories.cs.

virtual CreatorResult Marvel.Api.MarvelRestClient.FindStoryCreators ( string  storyId, CreatorRequestFilter  filter = default(CreatorRequestFilter)  )

virtual

Fetches lists of comic creators whose work appears in a specific story, with optional filters.

Parameters

storyId	Story unique identifier
filter	Search query filter data

Definition at line 109 of file Stories.cs.

virtual EventResult Marvel.Api.MarvelRestClient.FindStoryEvents ( string  storyId, EventRequestFilter  filter = default(EventRequestFilter)  )

virtual

Fetches lists of events in which a specific story appears, with optional filters.

Parameters

storyId	Story unique identifier
filter	Search query filter data

Definition at line 135 of file Stories.cs.

virtual SeriesResult Marvel.Api.MarvelRestClient.FindStorySeries ( string  storyId, SeriesRequestFilter  filter = default(SeriesRequestFilter)  )

virtual

Fetches lists of comic series in which the specified story takes place.

Parameters

storyId	Story unique identifier
filter	Search query filter data

Definition at line 160 of file Stories.cs.

---

The documentation for this class was generated from the following files:

• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Characters.cs
• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Comics.cs
• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Creators.cs
• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Events.cs
• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Series.cs
• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Stories.cs
• C:/Users/c20demo/Code/Source/Repos/marvel-csharp/src/Marvel.Api/Core.cs