APIv2 Corp CorporationSheet XML

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




Returns attributes relating to a specific corporation.

Data Caching

This method is cached according to the Modified Short Cache Style.

Limited Key

When used with the limited or full key of a character in the corporation, you get more information about the corporation.

Input Arguments

Name Type Description
KeyID int API Key ID. Must be a corporation access key
vCode char(64) API verification code

or for limited view

corporationID int Corporation ID to retrieve information for

Note: if corporation ID is supplied, API key will be ignored - you get public info even if you supply a key that allows access to the extended info.

Output XML

<?xml version='1.0' encoding='UTF-8'?>
<eveapi version="2">
  <currentTime>2010-02-26 05:34:14</currentTime>
    <corporationName>Banana Republic</corporationName>
    <ceoName>Mark Roled</ceoName>
    <stationName>Jita IV - Caldari Business Tribunal Information Center</stationName>
    <description>Garth's testing corp of awesome sauce, win sauce as it were. In this
                 corp...&lt;br&gt;&lt;br&gt;IT HAPPENS ALL OVER</description>
    <url>some url</url>
    <allianceName>The Dead Rabbits</allianceName>
    <rowset name="divisions" key="accountKey" columns="accountKey,description">
      <row accountKey="1000" description="Division 1"/>
      <row accountKey="1001" description="Division 2"/>
      <row accountKey="1002" description="Division 3"/>
      <row accountKey="1003" description="Division 4"/>
      <row accountKey="1004" description="Division 5"/>
      <row accountKey="1005" description="Division 6"/>
      <row accountKey="1006" description="Division 7"/>
    <rowset name="walletDivisions" key="accountKey" columns="accountKey,description">
      <row accountKey="1000" description="Wallet Division 1"/>
      <row accountKey="1001" description="Wallet Division 2"/>
      <row accountKey="1002" description="Wallet Division 3"/>
      <row accountKey="1003" description="Wallet Division 4"/>
      <row accountKey="1004" description="Wallet Division 5"/>
      <row accountKey="1005" description="Wallet Division 6"/>
      <row accountKey="1006" description="Wallet Division 7"/>
  <cachedUntil>2010-02-26 11:34:14</cachedUntil>

Parameters for use without an API key:

No Key

Public details of any corporation can be retrieved without an API key. Ways to get the corporationID include the alliance list and killmails.

Input Arguments

Name Type Description
corporationID int ID of the corporation for which you want details

If you pass both corporationID and the other parameters to the API server it will return the non-member version of the information just like you had only passed it corporationID.

Output XML

<?xml version='1.0' encoding='UTF-8'?>
<eveapi version="1">
  <currentTime>2007-12-02 19:41:53</currentTime>
    <corporationName>Marcus Corp</corporationName>
    <stationName>Jita IV - Caldari Business Tribunal Information Center</stationName>
    <description>Another Corp</description>
    <url />
    <allianceName>Starbase Anchoring Alliance</allianceName>
  <cachedUntil>2007-12-03 01:41:53</cachedUntil>

Output Columns

Corporation Sheet

The initial data is not repetitive and is not in a rowset. Other aspects - wallets and divisions for example - are.

Name Type Description
corporationID int(10) CorporationID
corporationName string Name of the Corporation. assume varString(255)
ticker string Corp Ticker, often used as a nickname. is 6 the max length for the corp ticker?
ceoID int(10) Character ID of the CEO. This will be 1 for closed corps.
ceoName string Character Name of the CEO. This will be 'EVE System' for closed corps.
stationID int(10) Station ID of the Corporation HQ.
stationName string Station Name of the Corporation HQ.
description string Corp Description Text
url string Corporation URL.
allianceID int(10) Alliance ID, if any.
allianceName string Alliance Name, if any. Is null if not present.
taxRate string Taxes on missions and ratting. (Use varChar as datatype s it might be double).
memberCount int Current number of Members.
memberLimit int Maximum number of members based on CEO corp Management skills.
shares int Shares outstanding.

Corporation Divisions rowset

Name Type Description
accountKey small int (<10000) Division key.
description string Division (corp hangar) Label.

Corporation Wallet Divisions rowset

Name Type Description
accountKey small int Wallet ID.
description string Wallet label.

Name Type Description
graphicID int Corporation ID of the member corporation.
shape1 smallInt Shape ID #
shape2 smallInt Shape ID #
shape3 smallInt Shape ID #
color1 smallInt Color ID #
color2 smallInt Color ID #
color3 smallInt Color ID #
Personal tools