AuctionInfo

Last update: 2013-05-15
A service that returns a list of auctions.

WEBSERVICE : http://webservices.vortexauction.com/functions.cfc?wsdl METHOD : AuctionInfo ARGUMENT : AUCTIONEER_ID [Numeric] Required | Your auctioneer ID ACCESS_KEY [String] Required | Your web service access key AUCTION_ID [Numeric] Optional | An auction ID EXTERNAL_AUCTION_ID [String] Optional | An external auction ID AUCTION_STATE [Numeric] Optional | One the following values 0 = All auctions 1 = Upcoming auctions 2 = Passed auctions 3 = Today's auctions
NOTE : 1. You must specify an AUCTION_ID or EXTERNAL_AUCTION_ID, if both then only AUCTION_ID will be used. 2. All the dates returned are in the auction's specified time zone.
RETURNS : AuctionInfoResponse ON FAILURE : <?xml version="1.0" encoding="utf-8"?> <AuctionInfoResponse> <Error> <Code>[Error code]</Code> <Message>[Error message]</Message> </Error> </AuctionInfoResponse> ON SUCCESS : <?xml version="1.0" encoding="utf-8"?> <AuctionInfoResponse> <AuctionList> <Auction> <Auction_ID>[Auction ID]</Auction_ID> <Auction_Type>[Type of auction]</Auction_Type> <Auction_Date>[Auction date]</Auction_Date> <External_Auction_ID>[Auction external ID]</External_Auction_ID> <Access_Type>[Auction access type]</Access_Type> <Name>[Auction name]</Name> <Description>[Auction description]</Description> <Active>[Auction active flag (0 or 1)]</Active> <Assisted>[Auction assisted flag (0 or 1)]</Assisted> <Demo>[Auction demo flag (0 or 1)]</Demo> <Ended>[Auction ended flag (0 or 1)]</Ended> </Auction> ... </AuctionList> </AuctionInfoResponse>
ERROR CODES : 00 = An unexpected error occured. 01 = Missing or invalid arguments. 02 = Invalid auctioneer id and/or access key.
EXAMPLES : COLDFUSION : <cfinvoke webservice="http://webservices.vortexauction.com/functions.cfc?wsdl" method="AuctionInfo" returnvariable="result"> <cfinvokeargument name="Auctioneer_ID" value="0" /> <cfinvokeargument name="Access_Key" value="..." /> <cfinvokeargument name="Auction_ID" value="0" /> <cfinvokeargument name="External_Auction_ID" value="..." /> <cfinvokeargument name="Auction_State" value="0" /> </cfinvoke> <cfdump var=#result# /> PHP : class AuctionInfo { function AuctionInfo($Auctioneer_ID, $Access_Key, $Auction_ID, $External_Auction_ID, $Auction_State) { $this->Auctioneer_ID = $Auctioneer_ID; $this->Access_Key = $Access_Key; $this->Auction_ID = $Auction_ID; $this->External_Auction_ID = $External_Auction_ID; $this->Auction_State = $Auction_State; } } $soapClient = new SoapClient("http://webservices.vortexauction.com/functions.cfc?wsdl"); $params = new AuctionInfo(0, "...", 0, "...", 0); $result = $soapClient->AuctionInfo($params); var_dump($result);
TEST FORM: