floAuctionWeb API Documentation

Accessing default web interface

Querystring parameters:

• none

Returns HTML:

• Returned HTML is a functional interface that allows players to start, end, cancel and bid on auctions.

Authorization and basic AuctionScope details

Querystring parameters

• playername - The player trying to access the system. (optional after first successful call)
• password - The password that the player specified using "/webauction password {password}" (no spaces allowed in password). (optional after first successful call)

Returns JSON:

• An associative array of AuctionScope id to another associative array containing:
  • id - String AuctionScope id
  • name - String AuctionScope name
  • activeAuctions - Integer number of active in-game auctions (cannot exceed 1)
  • queuedAuctions - Integer number of queued in-game auctions
  • webAuctions - Integer number of auctions started from the web

Extra:

• Sets a cookie to remember authentication for future calls.

Retrieve AuctionScope details

Querystring parameters

• get - set to "auctionscope"
• id - AuctionScope id

Returns JSON:

• id - String AuctionScope id
• name - String AuctionScope name
• activeAuctions - Integer number of active in-game auctions (cannot exceed 1)
• queuedAuctions - Integer number of queued in-game auctions
• webAuctions - Integer number of auctions started from the web

User Permissions/Capabilities

Querystring parameters

• get - set to "permissions"

Returns JSON:

• name - String Player's name
• canAuction - Boolean whether a player can start normal (unsealed) web auctions
• canSealedAuction - Boolean whether a player can start sealed web auctions
• canBid - Boolean whether a player can bid on auctions
• canAdmin - Boolean whether a player can do admin functions like cancelling other players auctions, confiscating items and suspending players.

More to come as added