AuctionGetAdminURL

A service that returns the URL to an auction for the admin.


WEBSERVICE  : http://webservices.vortexauction.com/functions.cfc?wsdl
METHOD      : AuctionGetAdminURL
ARGUMENT    : AUCTIONEER_ID       [Numeric] Required | Your auctioneer ID
              ACCESS_KEY          [String]  Required | Your web service access key
              AUCTION_ID          [Numeric] Optional | The ID of the target auction
              EXTERNAL_AUCTION_ID [String]  Optional | The external ID of the target auction
              MODULE              [Numeric] Optional | The type of module to access
                 1 = Director console (clerk screen), default.
                 2 = Toteboard. 
             

NOTE        : 1. You must specify an AUCTION_ID or EXTERNAL_AUCTION_ID, if both, then only AUCTION_ID will be used.


RETURNS     : AuctionGetAdminURLResponse
ON FAILURE  : <?xml version="1.0" encoding="utf-8"?>
              <AuctionGetAdminURLResponse>
                  <Error>
                      <Code>[Error code]</Code>
                      <Message>[Error message]</Message>
                  </Error>
              </AuctionGetAdminURLResponse>
ON SUCCESS  : <?xml version="1.0" encoding="utf-8"?>
              <AuctionGetAdminURLResponse>
                  <URL>[Auction URL]</URL>
              </AuctionGetAdminURLResponse>

ERROR CODES : 00 = An unexpected error occured.
              01 = Missing or invalid arguments.
              02 = Invalid auctioneer ID and/or access key.
              03 = Could not find the specified auction.

EXAMPLES    :
              COLDFUSION :
              <cfinvoke webservice="http://webservices.vortexauction.com/functions.cfc?wsdl" method="AuctionGetAdminURL" 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="Module" value="0" />
              </cfinvoke>
              <cfdump var=#result# />
              
              PHP :
              class AuctionGetAdminURL {
                  function AuctionGetAdminURL($Auctioneer_ID, $Access_Key, $Auction_ID, $External_Auction_ID, $Module) 
                  {
                      $this->Auctioneer_ID = $Auctioneer_ID;
                      $this->Access_Key = $Access_Key;
                      $this->Auction_ID = $Auction_ID;
                      $this->External_Auction_ID = $External_Auction_ID;
                      $this->Module = Module;
                  }
              }
              $soapClient = new SoapClient("http://webservices.vortexauction.com/functions.cfc?wsdl");
              $params = new AuctionGetAdminURL(0, "...", 0, "...", 0);     
              $result = $soapClient->AuctionGetAdminURL($params);
              var_dump($result);