APIv2 Char Locations XML

From EVEDev
Revision as of 12:12, 25 April 2012 by 195.6.79.204 (Talk)

Jump to: navigation, search
Api.pngAPI Methods - Category Home - API Overview - API Page Index - API Libraries - API Wanted Features

Contents

/char/Locations.xml.aspx

Overview

Call will return the items name (or its type name if no user defined name exists) as well as their x,y,z coordinates. Coordinates should all be 0 for valid locations located inside of stations.

These can ONLY be valid locationIDs (that is items which have meaningful location coordinates. (0, 0, 0) returned for items in hangars that could have valid coordinates) and must be owned by the character or corporation associated with the key. Any attempts at illegal input will result in a completely empty return. This is done to avoid any sort of scraping or giving out more information than is appropriate (f.e. validating that a given itemID is indeed a valid location but does not belong to the owner associated with the key). To differentiate this form of invalid input from other invalid input error code 135 will be thrown for this error.

Data Caching

This method is cached according to the Short Cache Style.

Input Arguments

Name Type Description
keyID int The ID of the Customizable API Key for authentication, found at: https://support.eveonline.com/api.
vCode char(64) The user defined or CCP generated Verification Code for the Customizable API Key, found at https://support.eveonline.com/api.
characterID int The ID of the character for the requested data, from Character List. (Only required when use keyID that works with multiple characters)
IDs long Comma separated list of itemIDs

Output XML

 
<eveapi version="2">
  <currentTime>2012-04-25 09:32:18</currentTime>
  <result>
    <rowset name="locations" key="itemID" columns="itemID,itemName,x,y,z">
      <row itemID="887875612" itemName="Test" x="-2437787459620" y="154215621450" z="428974561360" />
    </rowset>
  </result>
  <cachedUntil>2012-04-25 10:32:18</cachedUntil>
 
</eveapi>

Output Rowset Columns

Name Type Description
itemID long The unique item ID number.
itemName string The item name.
x long The x coordinate.
y long The y coordinate.
z long The z coordinate.
Personal tools