APIv2 Char JournalEntries XML

From EVEDev

Jump to: navigation, search
Image:Api.pngAPI Methods - Category Home - API Libraries - API Usage Examples - API Method Reference - API Page Index

Contents

[edit] /char/WalletJournal.xml.aspx

[edit] Overview

Returns a list of journal transactions for character.

[edit] Data Caching

This method is cached according to the Long Cache Style.

[edit] Input Arguments

Name Type Description
accountKey int It isn't necessary to specify accountKey for characters because they have only one wallet (accountKey=1000).
apiKey char(64) Full access API key of account.
beforeRefID int Used for walking the journal backwards to get more entries; see Journal Walking, below.
characterID int The character you are requesting data for.
userID int userID of account for authentication.

[edit] Output XML

 
<eveapi version="2">
  <currentTime>2008-08-22 12:00:16</currentTime>
  <result>
    <rowset name="entries" key="refID"
     columns="date,refID,refTypeID,ownerName1,ownerID1,ownerName2,ownerID2,argName1,argID1,amount,balance,reason">
      <row date="2008-08-22 03:36:00" refID="1578932679" refTypeID="54" ownerName1="corpslave"
           ownerID1="150337897" ownerName2="Secure Commerce Commission" ownerID2="1000132"
           argName1="" argID1="0" amount="-8396.99" balance="576336941.61" reason="" />
      <row date="2008-08-22 03:36:00" refID="1578932678" refTypeID="2" ownerName1="anonymous"
           ownerID1="30497503" ownerName2="corpslave" ownerID2="150337897"
           argName1="725524391" argID1="0" amount="1399498.50" balance="576345338.60" reason="" />
      <row date="2008-08-21 22:18:00" refID="1578164958" refTypeID="42" ownerName1="corpslave"
           ownerID1="150337897" ownerName2="" ownerID2="0"
           argName1="" argID1="0" amount="-152939.40" balance="574647640.10" reason="" />
      <row date="2008-08-21 21:42:00" refID="1578064292" refTypeID="46" ownerName1="corpslave"
           ownerID1="150337897" ownerName2="Secure Commerce Commission" ownerID2="1000132"
           argName1="" argID1="1" amount="-100.00" balance="576279220.79" reason="" />
      <row date="2008-08-21 08:35:00" refID="1576226363" refTypeID="63" ownerName1="corpslave"
           ownerID1="150337897" ownerName2="Secure Commerce Commission" ownerID2="1000132"
           argName1="9956913" argID1="0" amount="-20200000.00" balance="573681668.81" reason="" />
      <row date="2008-08-21 00:12:00" refID="1575178039" refTypeID="64" ownerName1="Secure Commerce Commission"
           ownerID1="1000132" ownerName2="corpslave" ownerID2="150337897"
           argName1="9956913" argID1="0" amount="5300000.00" balance="612310142.18" reason="" />
      <row date="2008-08-20 05:14:00" refID="1572522021" refTypeID="85" ownerName1="CONCORD"
           ownerID1="1000125" ownerName2="corpslave" ownerID2="150337897"
           argName1="" argID1="30002672" amount="5891907.60" balance="609292267.52"
           reason="17058:5,17066:3,24076:3,17071:2,24020:1,17082:1,24155:1,..." />
      <row date="2008-08-20 05:19:00" refID="1572531631" refTypeID="34" ownerName1="anonymous"
           ownerID1="30497503" ownerName2="corpslave" ownerID2="150337897"
           argName1="" argID1="30497503" amount="911000.00" balance="611148267.52" reason="" />
      <row date="2008-08-20 05:19:00" refID="1572531630" refTypeID="33" ownerName1="anonymous"
           ownerID1="30497503" ownerName2="corpslave" ownerID2="150337897"
           argName1="" argID1="30497503" amount="945000.00" balance="610237267.52" reason="" />
      <row date="2008-08-20 04:15:00" refID="1572401485" refTypeID="15" ownerName1="corpslave"
           ownerID1="150337897" ownerName2="Federal Intelligence Office" ownerID2="1000121"
           argName1="" argID1="1" amount="-504.00" balance="597984259.02" reason="" />
    </rowset>
  </result>
  <cachedUntil>2008-08-22 12:15:16</cachedUntil>
</eveapi>
 

[edit] Output Rowset Columns

Name Type Description
date date string Date & time of the transaction
refID int ID of transaction. Guaranteed to be unique with this page call; subject to renumbering periodically [1]. Use the last listed refID with the beforeRefID argument to walk the list (see Journal Walking, below).
refTypeID int Transaction type. See RefTypes.
ownerName1 string Name of first party in the transaction.
ownerID1 int Character or corporation ID of the first party.
ownerName2 string Name of second party in the transaction.
ownerID2 int Character or corporation ID of the second party.
argName1 varies See Arguments, below.
argID1 int See Arguments, below.
amount decimal The amount transferred between parties (if this shows up in the in-game wallet as green, the number is positive; if red, then negative).
balance decimal The overall balance in this wallet, after this transaction.
reason string See Arguments, below.


[edit] Arguments

Several RefTypes have special meanings for the argName1, argID1, and reason columns.

RefTypeID RefTypeName argName1 argID1 reason comment
1 Player Trading Station name Station ID arg describes where the direct player trade took place. See staStations table.
2 Market Transaction transactionID 0 See MarketTransactions API
10 Player Donation 0 user-entered text The donating player is free to enter text with the transfer, which shows up in the reason column here.
17 Bounty Prize NPC Name NPC ID This was replaced with refTypeID 85 when Trinity was released.
19 Insurance Destroyed ship's typeID 0 See invTypes table.
35 CSPA Player name Player characterID Player is the person whom you're trying to contact.
37 Corporation Account Withdrawl 0 user-entered text Similar to player donations; the donating corporation is free to enter text with the transfer, which shows up in the reason column here.
56 Manufacturing Job ID 0 See Industry Jobs API.
63, 64, 71, 72, 73, 74, 79, 80, 81, 82 Various contract types Contract ID? 0
85 Bounty Prizes solarSystemID (see mapSolarSystems table) NPC ID:quantity killed[,id:qty[,...]] For each type of NPC killed, its typeID is followed by a colon and the quantity killed. These pairs are seperated by commas, and if there are too many (more than about 60 characters' worth) the list is ended with a literal ",..." to indicate that more have been left off the list.

The complete refType reference can be accessed with the appropriate API. More information can be found here.

[edit] Journal Walking

The journal is configured to provide up to 1000 entries per request. It is also configured to allow you to view up to one week's worth of data. If the first 1000 entries you view stretch back further than a week, then you will not need to do any walking. However, if you have enough entries in your journal that 1000 is less than a week, you can walk backwards in the log to get more data.

Walking is performed by specifying the beforeRefID parameter as the lowest refID you have seen so far. You will then get another page with entries. This process can be repeated until you have gone back a week. The server will return an error if you attempt to go back farther.

Programmatically, it will be easiest to just loop while you are getting the max number of entries from the server, stopping when the server returns less than the max (i.e. you get 853 entries in a pull), the oldest entry is over a week old, or the server returns an error.

[edit] References

Personal tools