Roster:API

From WoWRosterWiKi
(Difference between revisions)
Jump to: navigation, search
 
Line 2: Line 2:
 
{{Disclaimer}}
 
{{Disclaimer}}
 
{{MainMenu|Roster}}
 
{{MainMenu|Roster}}
 +
 
==Roster API==
 
==Roster API==
The roster to wow api is a set of scripts that will use the new blizzard feeds for character and guild information from there servers for use with roster and its addons
+
The Roster to WoW API uses the feeds from Blizzard for character and guild information and can be used in Roster and its AddOns.
Features include
+
*Character info
+
**Basic information: name, level, class, race, gender, faction, guild, achievement points
+
**Optional fields: equipped items, stats, reputation, primary and secondary skills, achievements/statistics, talents, titles, collected mounts and companions, quests, profession recipes, Hunter pets, PvP information
+
  
*Guild
+
'''Features include:'''
**Basic information: name, level, achievement points
+
* Character info
**Optional fields: members (roster), achievements
+
** Basic information: name, level, class, race, gender, faction, guild, achievement points
 +
** Optional fields: equipped items, stats, reputation, primary and secondary skills, achievements/statistics, talents, titles, collected mounts and companions, quests, profession recipes, Hunter pets, PvP information
  
*Arena Teams
+
* Guild
**Basic information: name, ranking, rating, weekly/season statistics
+
** Basic information: name, level, achievement points
**Optional fields: members (roster)
+
** Optional fields: members (roster), achievements
  
==Char API==
+
* Arena Teams
Used to pull info from the WoW Api About any given Character level 10 and up<br>
+
** Basic information: name, ranking, rating, weekly/season statistics
Use:<code> $roster->api->Char->getCharInfo('Zangarmarsh,'Ulminia','1:2:3'); </code><br>
+
** Optional fields: members (roster)
Returns json formated arrays contaning data given from the array of fields listed below<br>
+
  
The getCharInfo has 3 variables ($Server, $CharName, $Fields) respectfully.
 
*$Server - the name of the server the character is located on
 
*$CharName - the name of the character
 
*$Fields - the fields you want to get for this character use ":" to seperate multiple fields
 
  
The Field options are as fallows
+
==Character API==
*'''1''' (''guild'') - A summary of the guild that the character belongs to. If the character does not belong to a guild and this field is requested, this field will not be exposed.
+
Used to query for data on any valid Character (level 10 and up)
*'''2''' (''stats'') - A map of character attributes and stats.
+
 
*'''3''' (''talents'') - A list of talent structures.
+
Usage:
*'''4''' (''items'') - list of items equipted by the character. Use of this field will also include the average item level and average item level equipped for the character.
+
<php>$roster->api->Char->getCharInfo($Server, $CharName, $Fields);</php>
*'''5''' (''reputation'') - A list of the factions that the character has an associated reputation with.
+
Returns a JSON formatted array contaning data from the fields requested
*'''6''' (''titles'') - A list of the titles obtained by the character.
+
 
*'''7''' (''professions'') - A list of the character's professions. It is important to note that when this information is retrieved, it will also include the known recipes of each of the listed professions.
+
getCharInfo has 3 parameters ($Server, $CharName, $Fields)
*'''8''' (''appearance'') - A map of values that describes the face, features and helm/cloak display preferences and attributes.
+
* $Server - the name of the server the character is located on
*'''9''' (''companions'') - A list of all of the non-combat pets obtained by the character.
+
* $CharName - the name of the character
*'''10''' (''mounts'') - A list of all of the mounts obtained by the character.
+
* $Fields - specific data you want to get for this character, use ":" for multiple fields
*'''11''' (''pets'') - A list of all of the combat pets obtained by the character.
+
 
*'''12''' (''achievements'') - A map of achievement data including completion timestamps and criteria information.
+
Field options are as follows:
*'''13''' (''progression'') - A list of raids and bosses indicating raid progression and completedness.
+
* '''1''' (''guild'') - A summary of the guild that the character belongs to. If the character does not belong to a guild and this field is requested, this field will not be exposed.
*'''14''' (''pvp'') - A list of battleground vistories and teams.
+
* '''2''' (''stats'') - A map of character attributes and stats.
*'''15''' (''quests'') - A list of completed quests by the character.
+
* '''3''' (''talents'') - A list of talent structures.
*'''16''' (''feed'') - A list of recent achievements items obtained, progression, statistics.
+
* '''4''' (''items'') - A list of items equipted by the character. Use of this field will also include the average item level and average item level equipped for the character.
 +
* '''5''' (''reputation'') - A list of the factions that the character has an associated reputation with.
 +
* '''6''' (''titles'') - A list of the titles obtained by the character.
 +
* '''7''' (''professions'') - A list of the character's professions. It is important to note that when this information is retrieved, it will also include the known recipes of each of the listed professions.
 +
* '''8''' (''appearance'') - A map of values that describes the face, features and helm/cloak display preferences and attributes.
 +
* '''9''' (''companions'') - A list of all of the non-combat pets obtained by the character.
 +
* '''10''' (''mounts'') - A list of all of the mounts obtained by the character.
 +
* '''11''' (''pets'') - A list of all of the combat pets obtained by the character.
 +
* '''12''' (''achievements'') - A map of achievement data including completion timestamps and criteria information.
 +
* '''13''' (''progression'') - A list of raids and bosses indicating raid progression and completedness.
 +
* '''14''' (''pvp'') - A list of battleground vistories and teams.
 +
* '''15''' (''quests'') - A list of completed quests by the character.
 +
* '''16''' (''feed'') - A list of recent achievements items obtained, progression, statistics.
  
 
==Guild API==
 
==Guild API==
 +
Used to query for data on any valid Guild
  
Used to pull info from the WoW Api About any given Guild<br>
+
Usage:
Use:<code> $roster->api->Guild->getGuildInfo($rname, $name, $fields); </code><br>
+
<php>$roster->api->Guild->getGuildInfo($rname, $name, $fields);</php>
Returns json formated arrays contaning data given from the array of fields listed below<br>
+
Returns a JSON formatted array contaning data from the fields requested
  
The getGuildInfo has 3 variables ($rname, $name, $fields) respectfully.
+
getGuildInfo has 3 variables ($rname, $name, $fields)
*$ranme - the name of the server the guild is located on
+
* $ranme - the name of the server the guild is located on
*$name - the name of the Guild
+
* $name - the name of the Guild
*$Fields - the fields you want to get for this guild use ":" to seperate multiple fields
+
* $Fields - specific data you want to get for this character, use ":" for multiple fields
  
The Field options are as fallows
+
Field options are as follows
*'''1''' (''members'') - A summary of the guilds members.
+
* '''1''' (''members'') - A summary of the guilds members.
*'''2''' (''achievements'') - an array of guild achievements completed (only id's given).
+
* '''2''' (''achievements'') - an array of guild achievements completed (only id's given).
*'''3''' (''news'') - A list of recent guild news.
+
* '''3''' (''news'') - A list of recent guild news.
  
 
'''Guild rewards'''
 
'''Guild rewards'''
<code>$roster->api->Guild->getGuildrewards($rname, $name, $fields)</code>
+
<php>$roster->api->Guild->getGuildrewards($rname, $name, $fields)</php>
 
This returns a list of the rewards the specified guild has earned.
 
This returns a list of the rewards the specified guild has earned.
 +
  
 
==Data API==
 
==Data API==
 +
<php>$roster->api->Data->getRacesInfo()</php>
 +
* Returns a list of raceId's with faction alignment
  
<code>$roster->api->Data->getRacesInfo()</code><br>
+
<php>$roster->api->Data->getQuestInfo($id)</php>
* This code returns a list of raceId's with faction alignment
+
* Returns info for the requested quest id ($id)
<br>
+
<code>$roster->api->Data->getQuestInfo($id)</code><br>
+
* This code returns some info for a quest
+
 
<code>
 
<code>
 
   "id":13157,
 
   "id":13157,
Line 80: Line 86:
 
   "level":79
 
   "level":79
 
</code>
 
</code>
<br>
+
 
<code>$roster->api->Data->getClassesInfo()</code><br>
+
<php>$roster->api->Data->getClassesInfo()</php>
*This returns id name and power type for all classes
+
* Returns id name and power type for all classes
<br>
+
 
<code>$roster->api->Data->getItemInfo($itemID,$gem0=null,$gem1=null,$gem2=null,$enchant=null,$es=false)</code><br>
+
<php>$roster->api->Data->getItemInfo($itemID, $gem0=null, $gem1=null, $gem2=null, $enchant=null, $es=false)</php>
**NOTE: $gem0,$gem1,$gem2,$enchant,$es are nto used as of yet
+
* Returns JSON data for the formation of tooltips of the given item id
*Returns Json data for the formation of tooltips of the given item id.
+
{{Note|$gem0, $gem1, $gem2, $enchant, $es are not used as of yet}}
<br>
+
 
<code>$roster->api->Data->getAchievInfo()</code><br>
+
<php>$roster->api->Data->getAchievInfo()</php>
*Returns the list of all achievements and catagories.
+
* Returns the list of all achievements and categories
<br>
+
 
 +
 
 
==Realm API==
 
==Realm API==
 +
 +
 
==Team API==
 
==Team API==
 +
 +
 
==Talent API==
 
==Talent API==

Latest revision as of 03:49, 23 May 2012

WR.net

Important note: When you edit this page, you agree to release your contribution into the public domain.
If you do not want this or can not do this because of license restrictions, please do not edit.

Contents


Roster API

The Roster to WoW API uses the feeds from Blizzard for character and guild information and can be used in Roster and its AddOns.

Features include:


Character API

Used to query for data on any valid Character (level 10 and up)

Usage:

$roster->api->Char->getCharInfo($Server, $CharName, $Fields);

Returns a JSON formatted array contaning data from the fields requested

getCharInfo has 3 parameters ($Server, $CharName, $Fields)

Field options are as follows:

Guild API

Used to query for data on any valid Guild

Usage:

$roster->api->Guild->getGuildInfo($rname, $name, $fields);

Returns a JSON formatted array contaning data from the fields requested

getGuildInfo has 3 variables ($rname, $name, $fields)

Field options are as follows

Guild rewards

$roster->api->Guild->getGuildrewards($rname, $name, $fields)

This returns a list of the rewards the specified guild has earned.


Data API

$roster->api->Data->getRacesInfo()

$roster->api->Data->getQuestInfo($id)

 "id":13157,
 "title":"The Crusaders' Pinnacle",
 "reqLevel":77,
 "suggestedPartyMembers":0,
 "category":"Icecrown",
 "level":79

$roster->api->Data->getClassesInfo()

$roster->api->Data->getItemInfo($itemID, $gem0=null, $gem1=null, $gem2=null, $enchant=null, $es=false)
Info.png Note: $gem0, $gem1, $gem2, $enchant, $es are not used as of yet

$roster->api->Data->getAchievInfo()


Realm API

Team API

Talent API

Personal tools
Namespaces
Variants
Actions
WoWRoster
Preview Roster
Navigation
Toolbox