AfterMarket
[ class tree: AfterMarket ] [ index: AfterMarket ] [ all elements ]
AfterMarket
Packages:
AfterMarket
DomainManager

Tutorials/Manuals:
Package-level: Classes:
AfterMarket
API
AttachmentContents
Auction
AuctionBid
AuctionCategory
Bidder
BuyerRating
CanceledAuctionInfo
Catalog
CounterOffer
Dict
Dictionary
Domain
Event
InvitedBidder
Listing
ListingAttachment
ListingDescFileExt
ListingDescription
ListingDescType
ListingOptions
MarketOptions
MarketplacePortals
NDObject
Offer
Operation
OperationResult
ProposedOffer
RequiredDeposit
SedoObject
SellerRating
Verificator

Class: AfterMarket

Source Location: /AfterMarket.class.php

Class AfterMarket

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Method Summary | Methods Detail | Constants Summary | Constants Detail

The main AfterMarket SOAP API class.

Functions of this class are the SOAP API methods which are listed in the WSDL file.

Located in /AfterMarket.class.php [line 34] 

API
   |
   --AfterMarket

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Method Summary | Methods Detail | Constants Summary | Constants Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From API

API::checkMyFunds()
Check my account balance
API::getCurrentTime()
Returns current time as a Unix timestamp.
API::getMyBalance()
Returns current balance on the account.
API::getMyCurrency()
Returns the account currency.
API::getMyUserId()
Returns the identifier of the logged-in user.
API::keepAlive()
Null function - does nothing.
API::login()
Creates a new session for specified user, returns session authorization code.
API::logout()
Closes user session

Inherited From API

API::MAXIMUM_DAILY_OPERATIONS
API::MAXIMUM_OPEN_SESSIONS
API::MAXIMUM_PAGE_SIZE

[ Top ]
Constant Summary
Class Overview | Inherited Properties, Constants, and Methods | Constants Summary | Constants Detail | Method Summary | Methods Detail
AUCTIONS_BIDS_ANY   Show all auctions
AUCTIONS_BIDS_NO_OFFERS   Show auctions without offers
AUCTIONS_BIDS_OFFERS   Show auctions with offers
CATALOG_RESULT_ALREADY_ADDED   Domain is already listed in catalog
CATALOG_RESULT_ALREADY_REMOVED   Domain is already removed from catalog
CATALOG_RESULT_NO_DOMAIN   Domain is not listed on your acocunt for sale
CATALOG_RESULT_OK   Domain successfully added/removed from catalog
FOR_SALE_WHAT_ALL   Show all domain types
FOR_SALE_WHAT_FOR_SALE   Show domains set for sale
FOR_SALE_WHAT_NOT_FOR_SALE   Show domains not for sale
FOR_SALE_WHERE_ALL   Show all domain types
FOR_SALE_WHERE_EXTERNAL   Show pl domains
FOR_SALE_WHERE_GROUP   Show pl domains
FOR_SALE_WHERE_INTERNAL   Show domains registered with Dropped.pl
IMPORT_RESULT_ALREADY_ADDED   Domain has been already imported
IMPORT_RESULT_BELONGS_TO_ANOTHER_USER   Domain belongs to another user
IMPORT_RESULT_NOT_ALLOWED   User doesn't have permission to import external domain
IMPORT_RESULT_REGISTERED_WITH_DROPPED   Domain is already registered with Dropped.pl
IMPORT_RESULT_SUCCESS   Domain was imported successfuly
IMPORT_RESULT_WRONG_DOMAIN_TYPE   Domain of this TLD cannot be imported
MYAUCTIONS_ALL   Return all auctions
MYAUCTIONS_FM   Return First Minute auctions
MYAUCTIONS_LM   Return Last Minute auctions
MYAUCTIONS_NORMAL   Return regular auctions
MYAUCTIONS_WITHOUT_OFFERS   Return auctions without bids
MYAUCTIONS_WITH_OFFERS   Return auctions with bids
PLACE_BID_HIGHEST   Informs that the placed bid was highest
PLACE_BID_NOT_HIGHEST   Informs that the placed bid was not highest
PLACE_BID_RESERVE   Informs that the placed bid was highest but below reserve price
PROMOTE_AUCTION_CATEGORY   Informs that the placed bid was highest
PROMOTE_AUCTION_HOMEPAGE   Informs that the placed bid was not highest
SECURITY_DEPOSIT_IN   Transfer funds into security deposit
SECURITY_DEPOSIT_OUT   Transfer funds from securtiy deposit into your account
SHOW_LISTINGS_AND_AUCTIONS   Shows both listings and auctions
SHOW_ONLY_AUCTIONS   Shows only auctions
SHOW_ONLY_LISTINGS   Shows only listings

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Constants Summary | Constants Detail | Method Summary | Methods Detail
boolean   acceptCounterOffer()   Accepts purchase counter offer from seller
boolean   acceptOffer()   Accepts purchase offer
int   addAuction()   Inserts a new auction into the system.
void   addAuctionAttachment()   Add auction attachment
int   addAuctionFromOffer()   Starts a new auction from received domain purchase offer.
boolean   addBlockedBidder()   Add bidder to seller blocked bidders list
OperationResult[]   addDomainsToCatalog()   Adds domains to a marketplace catalog.
boolean   addDomainToCatch()   Add domain to catch
void   addListingAttachment()   Add domain for sale attachment
RequiredDeposit   buyNow()   Purchases a domain for a BIN price.
boolean   buyNowProposed()   Purchases a proposed domain (unpaid in private auction)
CanceledAuctionInfo   cancelAuction()   Cancels an active auction
boolean   cancelCounterOffer()   Cancel counter offer made by seller
boolean   checkAttachmentFileName()   Check attachment file name
boolean   checkMyFunds()   Check my account balance
boolean   clearEvents()   Marks events as seen.
int   counterOffer()   Make counteroffer.
int   createCatalog()   Creates a catalog grouping marketplace listings.
int   currencyGranularity()   Returns the minimum price granularity for given currency
void   deleteAuctionAttachment()   Delete auction attachment
boolean   deleteBlockedBidder()   Delete blocked bidder from seller blocked bidders list
boolean   deleteCatalog()   Deletes a marketplace catalog
void   deleteListingAttachment()   Delete sale attachment
boolean   deletePastAuction()   Deletes finished auction
boolean   deleteWaitingAuction()   Deletes waiting auction
float   exchange()   Exchanges currency.
string   formatTime()   Returns a formatted string with date and time derived from givenUnix timestamp.
string   fromIDN()   Converts UTF domain name into ASCII Punycode form
Dictionary[]   getAttachmentExtensions()   Get attachment extensions
ListingAttachment[]   getAuctionAttachment()   Get auction attachments
AuctionBid[]   getAuctionBids()   Retrieves the list of bids in an auction.
int   getAuctionBidsCount()   Gets the number of bids in an auction.
ListingDescription[]   getAuctionDescription()   Get auction description
Auction   getAuctionInfo()   Retrieves information about one auction.
Auction[]   getAuctions()   Retrieves the list of auctions listed in the marketplace.
int   getAuctionsCount()   Gets the number of auctions listed on the marketplace and matching specified input criteria.
Bidder[]   getBlockedBidders()   Get blocked bidders for specified seller
int   getBlockedBiddersCount()   Get number of blocked bidders list for specified seller
string   getBuyerNick()   Gets user marketplace nick used for buying domains.
BuyerRating   getBuyerRating()   Gets buyer rating information.
string   getCatalogName()   Returns catalog name
AuctionCategory[]   getCategories()   Retrieves the list marketplace categories.
int   getCategoriesCount()   Gets the number of marketplace categories.
Offer   getCounterOfferInfo()   Retrieves information about a domain received purchase counter offer.
string[]   getCurrencies()   Returns available currencies.
int   getCurrentTime()   Returns current time as a Unix timestamp.
Dictionary[]   getDescriptionTypes()   Get description types dictionary
Listing   getDomainForSale()   Retrieves data for a domain offered for sale on user account.
string   getDomainForSaleNote()   Gets a note from marketplace listing
Listing[]   getDomainsForSale()   Retrieves the list of domains for sale listed on user account
int   getDomainsForSaleCount()   Gets the number of domains for sale listed on user account.
Listing[]   getDomainsInCatalog()   Returns domains in catalog
int   getDomainsInCatalogCount()   Returns number of domains in catalog
ToCatchDomain[]   getDomainsToCatch()   Get domains to catch
int[]   getDomainsToCatchCount()   Get domains to catch count
Bidder[]   getInvitedBidders()   Retrieves the list of invited bidders for a private auction.
int   getInvitedBiddersCount()   Gets the number of invited bidders for a private auction.
ListingAttachment[]   getListingAttachment()   Get listing attachments
ListingDescription[]   getListingDescription()   Get description assigned to domain for sale
Listing   getListingInfo()   Retrieves marketplace listing for given domain.
Listing   getListingInfoById()   Retrieves marketplace listing for given id.
ListingOptions   getListingOptions()   Retrieves user marketplace options for domain
Listing[]   getListings()   Retrieves a list of domains offered for sale.
int   getListingsCount()   Gets the number of domains offered for sale matching specified criteria.
MarketOptions   getMarketplaceOptions()   Retrieves user marketplace options
Dictionary[]   getMarketplacePortals()   Get available marketplace portals
Auction[]   getMyAuctions()   Retrieves the list of user auctions.
int   getMyAuctionsCount()   Gets the number of active auctions listed by the user.
float   getMyBalance()   Returns current balance on the account.
Auction[]   getMyBids()   Retrieves the list of auctions where the user is bidding or watching.
int   getMyBidsCount()   Gets the number of auctions where the user is bidding or watching.
Catalog[]   getMyCatalogs()   Returns user's catalogs
int   getMyCatalogsCount()   Returns number of user's catalogs
CounterOffer[]   getMyCounterOffers()   Retrieves the list of submitted counteroffers.
int   getMyCounterOffersCount()   Gets the number of submitted counteroffers.
string   getMyCurrency()   Returns the account currency.
AuctionBid   getMyMaximumBid()   Retrieves the maximum user bid in a given auction.
Offer[]   getMyOffers()   Retrieves the list of submitted offers.
int   getMyOffersCount()   Gets the number of submitted offers.
float   getMySecurityDeposit()   Returns current security deposit on the account.
string   getMyUserId()   Returns the identifier of the logged-in user.
Event[]   getNewEvents()   Retrieves unseen events that occurred on the marketplace.
Offer   getOfferInfo()   Retrieves information about a domain purchase offer.
Auction[]   getPastAuctions()   Retrieves the list of finished auctions of the user.
int   getPastAuctionsCount()   Gets the number of finished auctions of the user.
CounterOffer[]   getPastCounterOffers()   Retrieves the list of past received counteroffers.
int   getPastCounterOffersCount()   Gets the number of past received counteroffers.
Auction[]   getPastFirstMinuteAuctions()   Retrieves the list of finished filtered by First Minute auctions for user.
Offer[]   getPastOffers()   Retrieves the list of inactive received offers.
int   getPastOffersCount()   Gets the number of inactive received offers.
float   getPrice()   Returns a price for specified service on the marketplace
ProposedOffer[]   getProposedOffers()   Retrieves the list of active offers for purchase of proposed domains (unpaid in private auction)
int   getProposedOffersCount()   Gets the number of active offers for purchase of blocked domains.
CounterOffer[]   getReceivedCounterOffers()   Retrieves the list of received counteroffers.
int   getReceivedCounterOffersCount()   Gets the number of received counteroffers.
Offer[]   getReceivedOffers()   Retrieves the list of active received offers.
int   getReceivedOffersCount()   Gets the number of active received offers.
Domain[]   getRegisteredDomains()   Retrieve the list of domains registered by the user.
int   getRegisteredDomainsCount()   Retrieve number of domains registered by the user.
boolean   getRequiredDeposit()   Checks if deposit is required for given domain.
string   getSellerNick()   Gets user marketplace nick used for selling domains.
SellerRating   getSellerRating()   Gets seller rating information.
Operation[]   getSoldDomains()   Retrieves the list of domains sold by the user.
int   getSoldDomainsCount()   Gets the number of domains sold by the user.
float   getUsedSecurityDeposit()   Returns currently used security deposit on the account.
boolean   groupDomainsForSale()   Creates a group of domains to be sold together on the marketplace.
OperationResult[]   importDomainsForSale()   Imports external domains for sale on user account.
boolean   inviteBidder()   Invites a bidder to a private auction
boolean   keepAlive()   Null function - does nothing.
string   login()   Creates a new session for specified user, returns session authorization code.
boolean   logout()   Closes user session
RequiredDeposit   makeOffer()   Makes a purchase offer for a domain on the marketplace.
int   nextBid()   Returns next possible bid value in an auction.
int   placeBid()   Places a bid in an auction.
boolean   promoteAuction()   Promotes the auction on the main page or category page.
boolean   rejectOffer()   Rejects a received offer.
boolean   removeDomainFromCatch()   Delete domain from catch
OperationResult[]   removeDomainsFromCatalog()   Removes domains from a marketplace catalog.
boolean   renameCatalog()   Renames a marketplace catalog
AttachmentContents[]   retrieveAuctionAttachment()   Get auction attachment file contents and file name
AttachmentContents[]   retrieveListingAttachment()   Retrive sale attachment file contents and file name
void   setAuctionDescription()   Add description to auction
boolean   setBuyerNick()   Sets marketplace nick for domain buying
boolean   setDomainCatchPriority()   Set catch priority for a domain
Listing   setDomainForSale()   Sets the price of a domain offered for sale.
boolean   setDomainForSaleNote()   Sets a note for marketplace listing.
void   setListingDescription()   Add description to domain for sale
boolean   setListingOptions()   Sets user marketplace listing options.
boolean   setMarketplaceOptions()   Sets user marketplace options.
boolean   setMySecurityDeposit()   Sets security deposit amount.
boolean   setSellerNick()   Sets marketplace nick for domain selleing
string   toIDN()   Converts Punycode ASCII domain name into UTF form
boolean   ungroupDomainsForSale()   Creates a group of domains to be sold together on the marketplace.
boolean   uninviteBidder()   Removes bidder invitation from a private auction.
boolean   withdrawOffer()   Withdraws a submitted offer.

[ Top ]
Methods
Class Overview | Inherited Properties and Methods | Constants Summary | Constants Detail | Method Summary | Methods Detail
acceptCounterOffer  [line 3774]

  boolean acceptCounterOffer( [string $email = null], [string $key = null], [boolean $check = false], int $counterofferId  )

Accepts purchase counter offer from seller

An Escrow transaction for specified domain is started with the price indicated in the offer by the seller.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $counterofferId:  Counter offer identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 11001, 11002, 11003, 11008, 11300, 11301 (see API Error Codes)

[ Top ]
acceptOffer  [line 3580]

  boolean acceptOffer( [string $email = null], [string $key = null], [boolean $check = false], int $offerId  )

Accepts purchase offer

An Escrow transaction for specified domain is started with the price indicated in the offer by the buyer.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $offerId:  Offer identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 11001, 11002, 11003, 11008, 11300, 11301 (see API Error Codes)

[ Top ]
addAuction  [line 532]

  int addAuction( string $email, string $key, boolean $check, string $name, string $cat1, string $cat2, int $price, string $currency, string $text, boolean $internal, int $method, string $authinfo, int $days, int $hour, boolean $private, [string $language = ""], [string $cat3 = ""], [int $bin = 0], [int $reserve = 0], [string $cat4 = ""], [string $portal = ""]  )

Inserts a new auction into the system.

A new domain auction is created in the system with specified parameters. This auction is waiting for 2 hours before it is started; in this period, it can be deleted by AfterMarket::deleteWaitingAuction() function.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Name of the domain to be listed in auction
string   $cat1:  First category ID (see AfterMarket::getCategories())
string   $cat2:  Second category ID (see AfterMarket::getCategories())
int   $price:  Auction price
string   $currency:  Auction currency
string   $text:  Auction description
boolean   $internal:  Whether the domain is registered with AfterMarket.pl (see API Object Statuses)
int   $method:  Domain transfer method (see API Object Statuses)
string   $authinfo:  Domain AuthInfo code
int   $days:  Auction length in days
int   $hour:  Auction ending hour
boolean   $private:  Private auction
string   $language:  Domain language (currently unused)
string   $cat3:  Third category
int   $bin:  Buy It Now price (currently unused)
int   $reserve:  Reserve price (currently unused)
string   $cat4:  Fourth category
string   $portal:  Portal where the auction will be visible

API Tags:
Return:  New auction ID
Access:  public

Information Tags:
Throws:  Exceptions: 10201, 10300, 10301, 11000, 11001, 11004, 11005, 11006, 11007, 11102, 11103, 11110 (see API Error Codes)

[ Top ]
addAuctionAttachment  [line 7290]

  void addAuctionAttachment( [string $email = null], [string $key = null], [boolean $check = false], int $auctionId, string $fileName, string $fileType, string $fileDescription, string $fileContents  )

Add auction attachment

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  auctionId
string   $fileName:  File Name
string   $fileType:  File MIME Type
string   $fileDescription:  File Description
string   $fileContents:  File Contents

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10101, 11107, 11111, 10313, 11503, 11502, 11504 (see API Error Codes)

[ Top ]
addAuctionFromOffer  [line 4029]

  int addAuctionFromOffer( [string $email = null], [string $key = null], [boolean $check = false], int $offerId, string $cat1, string $cat2, int $days, int $hour, boolean $private, int $bin, int $reserve  )

Starts a new auction from received domain purchase offer.

A new auction is entered in the system for specified domain. The starting price is the price entered in the purchase offer. The first bidder in the auction is the user who submitted the offer for the domain.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $offerId:  Offer identifier
string   $cat1:  First auction category
string   $cat2:  Second auction category
int   $days:  Auction length in days
int   $hour:  Auction ending hour
boolean   $private:  List auction as private
int   $bin:  Buy It Now price (currently unused)
int   $reserve:  Reserve price (currently unused)

API Tags:
Return:  New auction identifier
Access:  public

Information Tags:
Throws:  Exceptions: 10300, 11001, 11003, 11008, 11100, 11102, 11104, 11122, 11300, 11301 (see API Error Codes)

[ Top ]
addBlockedBidder  [line 7649]

  boolean addBlockedBidder( [string $email = null], [string $key = null], [boolean $check = false], string $bidderId  )

Add bidder to seller blocked bidders list

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $bidderId:  bidderId Bidder auctionId or email

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10307, 11400, 11127, 11124 (see API Error Codes)

[ Top ]
addDomainsToCatalog  [line 6686]

  OperationResult[] addDomainsToCatalog( [string $email = null], [string $key = null], [boolean $check = false], int $catalogId, string[] $names  )

Adds domains to a marketplace catalog.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $catalogId:  Catalog identifier
string[]   $names:  Domain names to be added to the catalog

API Tags:
Return:  Array of results for each domain. Result code can be one of CATALOG_RESULT_ constant values.
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11000, 11208 (see API Error Codes)

[ Top ]
addDomainToCatch  [line 6266]

  boolean addDomainToCatch( [string $email = null], [string $key = null], string $domain, boolean $priority  )

Add domain to catch

Parameters:
string   $email:  SOAP-API auth email
string   $key:  SOAP-API auth session code
string   $domain:  Domain name
boolean   $priority:  Catch priority

API Tags:
Access:  public


[ Top ]
addListingAttachment  [line 7226]

  void addListingAttachment( [string $email = null], [string $key = null], [boolean $check = false], string $name, string $fileName, string $fileType, string $fileDescription, string $fileContents  )

Add domain for sale attachment

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
string   $fileName:  File Name
string   $fileType:  File MIME Type
string   $fileDescription:  File Description
string   $fileContents:  File Contents

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 11200, 10103, 10313, 11503, 11502, 1504 (see API Error Codes)

[ Top ]
buyNow  [line 2550]

  RequiredDeposit buyNow( string $email, string $key, boolean $check, string $name, int $price, string $currency  )

Purchases a domain for a BIN price.

The domain is purchased for a Buy It Now price indicated on the marketplace. An Escrow transaction is immediately started for the domain.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
int   $price:  Buy It Now price
string   $currency:  Price currency

API Tags:
Return:  Object containing information about the required deposit
Access:  public

Information Tags:
Throws:  Exceptions: 11001, 11002, 11003, 11109, 11200, 11204 (see API Error Codes)

[ Top ]
buyNowProposed  [line 3440]

  boolean buyNowProposed( string $email, string $key, string $name  )

Purchases a proposed domain (unpaid in private auction)

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  Operation result
Access:  public


[ Top ]
cancelAuction  [line 1673]

  CanceledAuctionInfo cancelAuction( string $email, string $key, boolean $check, int $auctionId  )

Cancels an active auction

An active auction is canceled and a penalty fee is charged from the user account.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier

API Tags:
Return:  Operation result
Access:  public

Information Tags:
Throws:  Exceptions: 10201, 11113, 11114 (see API Error Codes)

[ Top ]
cancelCounterOffer  [line 3147]

  boolean cancelCounterOffer( [string $email = null], [string $key = null], [boolean $check = false], int $cofferId  )

Cancel counter offer made by seller

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $cofferId:  Counter Offer identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10102, 11008, 11300 (see API Error Codes)

[ Top ]
checkAttachmentFileName  [line 7628]

  boolean checkAttachmentFileName( [string $email = null], [string $key = null], string $fileName  )

Check attachment file name

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $fileName:  fileName

API Tags:
Return:  Returns true if file name is ok or false when it's wrong
Access:  public


[ Top ]
checkMyFunds  [line 249]

  boolean checkMyFunds( [string $email = null], [string $key = null], float $amount, string $currency  )

Check my account balance

Parameters:
string   $email:  SOAP-API auth email
string   $key:  SOAP-API auth session code
float   $amount:  Amount of funds to check
string   $currency:  Currency of input funds

API Tags:
Return:  True if has sufficent funds
Access:  public

Redefinition of:
API::checkMyFunds()
Check my account balance

[ Top ]
clearEvents  [line 1204]

  boolean clearEvents( [string $email = null], [string $key = null], string $type, int $count  )

Marks events as seen.

Events marked as seen will not be retrieved by the AfterMarket::getNewEvents() function. For a detailed discussion of events, see the API Events document.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $type:  Event type
int   $count:  Number of events to mark as seen

API Tags:
Access:  public


[ Top ]
counterOffer  [line 4240]

  int counterOffer( [string $email = null], [string $key = null], [boolean $check = false], int $offerId, int $price, string $currency, [string $message = ""]  )

Make counteroffer.

A higher price for the domain is proposed to the buyer. The buyer is notified via email.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $offerId:  Offer identifier
int   $price:  Counteroffer amount
string   $currency:  Counteroffer currency
string   $message:  Message to the buyer (optional)

API Tags:
Return:  Counter offer id
Access:  public

Information Tags:
Throws:  Exceptions: 10300, 10301, 10306, 11008, 11301 (see API Error Codes)

[ Top ]
createCatalog  [line 6573]

  int createCatalog( [string $email = null], [string $key = null], [boolean $check = false], string $name, boolean $private  )

Creates a catalog grouping marketplace listings.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Catalog name
boolean   $private:  The catalog will be private

API Tags:
Return:  New catalog identifier
Access:  public

Information Tags:
Throws:  Exceptions: 11207, 11209 (see API Error Codes)

[ Top ]
currencyGranularity  [line 2137]

  int currencyGranularity( string $email, string $key, string $currency  )

Returns the minimum price granularity for given currency

This function returns the minimum granularity of an price in an auction, given the auction currency. All bids must be a multiplication of this amount.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $currency:  Auction currency

API Tags:
Return:  Currency multiplication
Access:  public


[ Top ]
deleteAuctionAttachment  [line 7401]

  void deleteAuctionAttachment( [string $email = null], [string $key = null], [boolean $check = false], int $auctionId, int $attachmentId  )

Delete auction attachment

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  auctionId
int   $attachmentId:  attachmentId

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10101, 11107, 11111, 11500, 11501 (see API Error Codes)

[ Top ]
deleteBlockedBidder  [line 7693]

  boolean deleteBlockedBidder( [string $email = null], [string $key = null], [boolean $check = false], string $bidderId  )

Delete blocked bidder from seller blocked bidders list

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $bidderId:  bidderId Bidder auctionId or email

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10307, 11400, 11125 (see API Error Codes)

[ Top ]
deleteCatalog  [line 6610]

  boolean deleteCatalog( [string $email = null], [string $key = null], [boolean $check = false], int $id  )

Deletes a marketplace catalog

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $id:  Catalog identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11208 (see API Error Codes)

[ Top ]
deleteListingAttachment  [line 7361]

  void deleteListingAttachment( [string $email = null], [string $key = null], [boolean $check = false], string $name, int $attachmentId  )

Delete sale attachment

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
int   $attachmentId:  attachmentId

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 11200, 10103, 11500, 11501 (see API Error Codes)

[ Top ]
deletePastAuction  [line 1635]

  boolean deletePastAuction( string $email, string $key, boolean $check, int $auctionId  )

Deletes finished auction

This function removes an auction from the list returned by the AfterMarket::getPastAuctions() function. The auction will no longer be shown on the list.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10005, 11112 (see API Error Codes)

[ Top ]
deleteWaitingAuction  [line 1543]

  boolean deleteWaitingAuction( string $email, string $key, boolean $check, int $auctionId  )

Deletes waiting auction

This function deletes an auction that has been listed, but not yet started. After listing, an auction is waiting for two hours before it is placed on the marketplace. This function can be used to delete such waiting auction free of charge.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10005, 11111 (see API Error Codes)

[ Top ]
exchange  [line 354]

  float exchange( [string $email = null], [string $key = null], float $amount, string $from, [string $to = '']  )

Exchanges currency.

Parameters:
string   $email:  User email
string   $key:  User authorization code
float   $amount:  Source amount
string   $from:  Source currency
string   $to:  Target currency

API Tags:
Return:  Target amount
Access:  public


[ Top ]
formatTime  [line 337]

  string formatTime( string $email, string $key, int $time  )

Returns a formatted string with date and time derived from givenUnix timestamp.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $time:  Unix timestamp

API Tags:
Return:  Formatted and and time
Access:  public


[ Top ]
fromIDN  [line 310]

  string fromIDN( string $email, string $key, string $name  )

Converts UTF domain name into ASCII Punycode form

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  Converted name
Access:  public


[ Top ]
getAttachmentExtensions  [line 7612]

  Dictionary[] getAttachmentExtensions( [string $email = null], [string $key = null]  )

Get attachment extensions

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Dictionary values
Access:  public


[ Top ]
getAuctionAttachment  [line 7482]

  ListingAttachment[] getAuctionAttachment( [string $email = null], [string $key = null], string $auctionId  )

Get auction attachments

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $auctionId:  auctionId

API Tags:
Return:  ListingAttachment list
Access:  public

Information Tags:
Throws:  Exceptions: 10101, 11107, 11111 (see API Error Codes)

[ Top ]
getAuctionBids  [line 1899]

  AuctionBid[] getAuctionBids( string $email, string $key, int $start, int $size, int $auctionId  )

Retrieves the list of bids in an auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
int   $auctionId:  Auction identifier

API Tags:
Return:  Bid list
Access:  public


[ Top ]
getAuctionBidsCount  [line 1877]

  int getAuctionBidsCount( string $email, string $key, int $auctionId  )

Gets the number of bids in an auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $auctionId:  Auction ID

API Tags:
Return:  Number of auction bids
Access:  public


[ Top ]
getAuctionDescription  [line 7177]

  ListingDescription[] getAuctionDescription( [string $email = null], [string $key = null], string $auctionId  )

Get auction description

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $auctionId:  auctionId

API Tags:
Return:  ListingDescription list
Access:  public

Information Tags:
Throws:  Exceptions: 10101, 11107, 11111 (see API Error Codes)

[ Top ]
getAuctionInfo  [line 1501]

  Auction getAuctionInfo( string $email, string $key, int $auctionId  )

Retrieves information about one auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $auctionId:  Auction identifier

API Tags:
Return:  Auction object
Access:  public

Information Tags:
Throws:  Exceptions: 10101 (see API Error Codes)

[ Top ]
getAuctions  [line 5657]

  Auction[] getAuctions( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ''], [string $name = ''], [string $sellerId = ''], [string $category = ''], [int $priceFrom = 0], [int $priceTo = 0], [string $currency = ''], [int $bids = self::AUCTIONS_BIDS_ANY], [int $endDays = 0], [int $lengthFrom = 0], [int $lengthTo = 0], [int $catalogId = 0], [boolean $leftAnchor = false], [boolean $rightAnchor = false], [boolean $noNumbers = false], [boolean $noHyphens = false], [boolean $noIDN = false], [string $tld = ""], [string $language = ""]  )

Retrieves the list of auctions listed in the marketplace.

The marketplace is searched according to specified criteria. All criteria are optional and can be omitted.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)
string   $name:  String to search within domain names
string   $sellerId:  Seller identifier
string   $category:  Auction category
int   $priceFrom:  Minimum domain price
int   $priceTo:  Maximum domain price
string   $currency:  Price currency
int   $bids:  Whether the auction needs to have bids, one of AUCTIONS_BIDS_ constants
int   $endDays:  Number of days before end of auction
int   $lengthFrom:  Minimum domain length (unused)
int   $lengthTo:  Maximum domain length (unused)
int   $catalogId:  Catalog identifier (unused)
boolean   $leftAnchor:  Left anchor for searcj text (unused)
boolean   $rightAnchor:  Right anchor for search text (unused)
boolean   $noNumbers:  Exclude domains with numbers (unused)
boolean   $noHyphens:  Exclude domains with hyphens (unused)
boolean   $noIDN:  Exclude IDN domains (unused)
string   $tld:  Domain extension (unused)
string   $language:  Domain language (unused)

API Tags:
Return:  Auction list
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getAuctionsCount  [line 5540]

  int getAuctionsCount( [string $email = null], [string $key = null], [string $name = ''], [string $sellerId = ''], [string $category = ''], [int $priceFrom = 0], [int $priceTo = 0], [string $currency = ''], [int $bids = self::AUCTIONS_BIDS_ANY], [int $endDays = 0], [int $lengthFrom = 0], [int $lengthTo = 0], [int $catalogId = 0], [boolean $leftAnchor = false], [boolean $rightAnchor = false], [boolean $noNumbers = false], [boolean $noHyphens = false], [boolean $noIDN = false], [string $tld = ""], [string $language = ""]  )

Gets the number of auctions listed on the marketplace and matching specified input criteria.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  String to search within domain names
string   $sellerId:  Seller identifier
string   $category:  Auction category
int   $priceFrom:  Minimum domain price
int   $priceTo:  Maximum domain price
string   $currency:  Price currency
int   $bids:  Whether the auction needs to have bids - one of AUCTIONS_BIDS_ constants
int   $endDays:  Number of days before end of auction
int   $lengthFrom:  Minimum domain length (unused)
int   $lengthTo:  Maximum domain length (unused)
int   $catalogId:  Catalog identifier (unused)
boolean   $leftAnchor:  Left anchor for search text (unused)
boolean   $rightAnchor:  Right anchor for search text (unused)
boolean   $noNumbers:  Exclude domains with numbers (unused)
boolean   $noHyphens:  Exclude domains with hyphens (unused)
boolean   $noIDN:  Exclude IDN domains (unused)
string   $tld:  Domain extension (unused)
string   $language:  Domain language (unused)

API Tags:
Return:  Auction count
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getBlockedBidders  [line 7782]

  Bidder[] getBlockedBidders( [string $email = null], [string $key = null], int $start, int $size, string $memberId  )

Get blocked bidders for specified seller

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $memberId:  memberId Seller hash, email or auctionId

API Tags:
Return:  Bidder List
Access:  public

Information Tags:
Throws:  Exceptions: 10307, 11400 (see API Error Codes)

[ Top ]
getBlockedBiddersCount  [line 7741]

  int getBlockedBiddersCount( [string $email = null], [string $key = null], string $memberId  )

Get number of blocked bidders list for specified seller

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $memberId:  memberId Seller hash, email or auctionId

API Tags:
Return:  Number of blocked bidders
Access:  public

Information Tags:
Throws:  Exceptions: 10307, 11400 (see API Error Codes)

[ Top ]
getBuyerNick  [line 5824]

  string getBuyerNick( [string $email = null], [string $key = null], [string $memberId = '']  )

Gets user marketplace nick used for buying domains.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $memberId:  User identifier (if empty, returns nick of the current user)

API Tags:
Return:  User nick
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getBuyerRating  [line 6911]

  BuyerRating getBuyerRating( [string $email = null], [string $key = null], string $buyerId  )

Gets buyer rating information.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $buyerId:  Buyer identifier

API Tags:
Return:  Rating information
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getCatalogName  [line 6853]

  string getCatalogName( [string $email = null], [string $key = null], int $catalogId  )

Returns catalog name

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $catalogId:  Catalog identifier

API Tags:
Return:  Catalog name
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11208 (see API Error Codes)

[ Top ]
getCategories  [line 1140]

  AuctionCategory[] getCategories( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE]  )

Retrieves the list marketplace categories.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size

API Tags:
Return:  Category list
Access:  public


[ Top ]
getCategoriesCount  [line 1126]

  int getCategoriesCount( [string $email = null], [string $key = null]  )

Gets the number of marketplace categories.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of categories
Access:  public


[ Top ]
getCounterOfferInfo  [line 4464]

  Offer getCounterOfferInfo( string $email, string $key, int $counterofferId  )

Retrieves information about a domain received purchase counter offer.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $counterofferId:  Offer id

API Tags:
Return:  Offer data
Access:  public

Information Tags:
Throws:  Exceptions: 10102, 11300 (see API Error Codes)

[ Top ]
getCurrencies  [line 369]

  string[] getCurrencies( [string $email = null], [string $key = null]  )

Returns available currencies.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  currency list
Access:  public


[ Top ]
getCurrentTime  [line 202]

  int getCurrentTime( string $email, string $key  )

Returns current time as a Unix timestamp.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Current timestamp
Access:  public

Redefinition of:
API::getCurrentTime()
Returns current time as a Unix timestamp.

[ Top ]
getDescriptionTypes  [line 7597]

  Dictionary[] getDescriptionTypes( [string $email = null], [string $key = null]  )

Get description types dictionary

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Dictionary values
Access:  public


[ Top ]
getDomainForSale  [line 5496]

  Listing getDomainForSale( string $email, string $key, string $name  )

Retrieves data for a domain offered for sale on user account.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  domain name

API Tags:
Return:  Domain data
Access:  public

Information Tags:
Throws:  Exceptions: 11200 (see API Error Codes)

[ Top ]
getDomainForSaleNote  [line 4319]

  string getDomainForSaleNote( [string $email = null], [string $key = null], string $name  )

Gets a note from marketplace listing

A note is a textual description added to the marketplace listing. It allows the seller to post additional information pertaining to the domain.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  Note text
Access:  public

Information Tags:
Throws:  Exceptions: 10103, 11200 (see API Error Codes)

[ Top ]
getDomainsForSale  [line 5098]

  Listing[] getDomainsForSale( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [int $where = self::FOR_SALE_WHERE_ALL], [int $what = self::FOR_SALE_WHAT_ALL], [string $search = ''], [int $sort = 1], [int $idn = 0]  )

Retrieves the list of domains for sale listed on user account

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
int   $where:  Scope of search - one of FOR_SALE_WHERE_ constants
int   $what:  Type of domains for search - one of FOR_SALE_WHAT_ constants
string   $search:  Text to be searched within domain names
int   $sort:  Sort type
int   $idn:  IDN filter, 0 -> All, 1 -> No IDN, 2 -> Only IDN

API Tags:
Return:  Listing list
Access:  public


[ Top ]
getDomainsForSaleCount  [line 5017]

  int getDomainsForSaleCount( [string $email = null], [string $key = null], [int $where = self::FOR_SALE_WHERE_ALL], [int $what = self::FOR_SALE_WHAT_ALL], [string $search = ''], [int $idn = 0]  )

Gets the number of domains for sale listed on user account.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $where:  Scope of search - one of FOR_SALE_WHERE_ constants
int   $what:  Type of domains for search - one of FOR_SALE_WHAT_ constants
string   $search:  Text to be searched within domain names
int   $idn:  IDN filter, 0 -> All, 1 -> No IDN, 2 -> Only IDN

API Tags:
Return:  Domain list
Access:  public


[ Top ]
getDomainsInCatalog  [line 6800]

  Listing[] getDomainsInCatalog( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], int $catalogId  )

Returns domains in catalog

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
int   $catalogId:  Catalog identifier

API Tags:
Return:  Listing list
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11208 (see API Error Codes)

[ Top ]
getDomainsInCatalogCount  [line 6830]

  int getDomainsInCatalogCount( [string $email = null], [string $key = null], int $catalogId  )

Returns number of domains in catalog

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $catalogId:  Catalog identifier

API Tags:
Return:  Number of domains in catalog
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11208 (see API Error Codes)

[ Top ]
getDomainsToCatch  [line 6500]

  ToCatchDomain[] getDomainsToCatch( [string $email = null], [string $key = null]  )

Get domains to catch

Parameters:
string   $email:  SOAP-API auth email
string   $key:  SOAP-API auth session code

API Tags:
Return:  ToCatch Domains list
Access:  public


[ Top ]
getDomainsToCatchCount  [line 6538]

  int[] getDomainsToCatchCount( [string $email = null], [string $key = null]  )

Get domains to catch count

Parameters:
string   $email:  SOAP-API auth email
string   $key:  SOAP-API auth session code

API Tags:
Return:  ToCatch Domains count
Access:  public


[ Top ]
getInvitedBidders  [line 1855]

  Bidder[] getInvitedBidders( string $email, string $key, int $start, int $size, int $auctionId  )

Retrieves the list of invited bidders for a private auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
int   $auctionId:  Auction ID

API Tags:
Return:  Bidder list
Access:  public


[ Top ]
getInvitedBiddersCount  [line 1831]

  int getInvitedBiddersCount( string $email, string $key, int $auctionId  )

Gets the number of invited bidders for a private auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $auctionId:  Auction ID

API Tags:
Return:  Number of invited bidders
Access:  public


[ Top ]
getListingAttachment  [line 7443]

  ListingAttachment[] getListingAttachment( [string $email = null], [string $key = null], string $name  )

Get listing attachments

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  ListingAttachment list
Access:  public

Information Tags:
Throws:  Exceptions: 11200, 10103 (see API Error Codes)

[ Top ]
getListingDescription  [line 7134]

  ListingDescription[] getListingDescription( [string $email = null], [string $key = null], string $name  )

Get description assigned to domain for sale

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  ListingDescription list
Access:  public

Information Tags:
Throws:  Exceptions: 11200, 10103 (see API Error Codes)

[ Top ]
getListingInfo  [line 4390]

  Listing getListingInfo( string $email, string $key, string $name  )

Retrieves marketplace listing for given domain.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  Listing data
Access:  public


[ Top ]
getListingInfoById  [line 4417]

  Listing getListingInfoById( string $email, string $key, int $listingId  )

Retrieves marketplace listing for given id.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $listingId:  Listing id

API Tags:
Return:  Listing data
Access:  public


[ Top ]
getListingOptions  [line 6138]

  ListingOptions getListingOptions( [string $email = null], [string $key = null], string $name, [boolean $getDefaultValues = false]  )

Retrieves user marketplace options for domain

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Listing domain name
boolean   $getDefaultValues:  If flag has "use defalt global option" and param $getDefaultValues is true, returns global value

API Tags:
Return:  Marketplace listing options
Access:  public


[ Top ]
getListings  [line 4520]

  Listing[] getListings( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ''], [string $name = ''], [string $sellerId = ''], [string $category = ''], [int $priceFrom = 0], [int $priceTo = 0], [string $currency = ''], [boolean $negotiation = false], [int $lengthFrom = 0], [int $lengthTo = 0], [int $catalogId = 0], [boolean $leftAnchor = false], [boolean $rightAnchor = false], [boolean $noNumbers = false], [boolean $noHyphens = false], [boolean $noIDN = false], [string $tld = ""], [string $language = ""], [int $what = self::SHOW_LISTINGS_AND_AUCTIONS], [int $endtime = 0], [boolean $onlyIDN = false], [string $market = ""], [boolean $onlyWithOffers = false]  )

Retrieves a list of domains offered for sale.

The marketplace is searched according to specified criteria. All criteria are optional and can be omitted.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)
string   $name:  String to be searched in domain names
string   $sellerId:  Seller identifier
string   $category:  Marketplace category
int   $priceFrom:  Low price boundary
int   $priceTo:  High price boundary
string   $currency:  Price currency
boolean   $negotiation:  With price restrictions, return also domains that have no Buy It Now price.
int   $lengthFrom:  Low domain length boundary
int   $lengthTo:  High domain length boundary
int   $catalogId:  restrict search to domains with given catalog id
boolean   $leftAnchor:  Left anchor for search text (unused)
boolean   $rightAnchor:  Right anchor for search text (unused)
boolean   $noNumbers:  Exclude domains with numbers (unused)
boolean   $noHyphens:  Exclude domains with hyphens (unused)
boolean   $noIDN:  Exclude IDN domains (unused)
string   $tld:  Domain extension (unused)
string   $language:  Domain language (unused)
int   $what:  What listings are to be shown (one of the SHOW_* constants)
int   $endtime:  Endtime
boolean   $onlyIDN:  Exclude all non idn domains
string   $market:  Domain market
boolean   $onlyWithOffers:  Show only domains which received offers

API Tags:
Return:  Listing list
Access:  public

Information Tags:
Throws:  Exceptions: 11400 see API Error Codes)

[ Top ]
getListingsCount  [line 4775]

  int getListingsCount( [string $email = null], [string $key = null], [string $name = ''], [string $sellerId = ''], [string $category = ''], [int $priceFrom = 0], [int $priceTo = 0], [string $currency = ''], [boolean $negotiation = false], [int $lengthFrom = 0], [int $lengthTo = 0], [int $catalogId = 0], [boolean $leftAnchor = false], [boolean $rightAnchor = false], [boolean $noNumbers = false], [boolean $noHyphens = false], [boolean $noIDN = false], [string $tld = ""], [string $language = ""], [int $what = self::SHOW_LISTINGS_AND_AUCTIONS], [int $endtime = 0], [boolean $onlyIDN = false], [string $market = ""], [boolean $onlyWithOffers = false]  )

Gets the number of domains offered for sale matching specified criteria.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  String to be searched in domain names
string   $sellerId:  Seller identifier
string   $category:  Marketplace category
int   $priceFrom:  Low price boundary
int   $priceTo:  High price boundary
string   $currency:  Price currency
boolean   $negotiation:  With price restrictions, return also domains that have no Buy It Now price.
int   $lengthFrom:  Low domain length boundary
int   $lengthTo:  Hight domain length boundary
int   $catalogId:  restrict search to domains with given catalog id
boolean   $leftAnchor:  Left anchor for search text (unused)
boolean   $rightAnchor:  Right anchor for search text (unused)
boolean   $noNumbers:  Exclude domains with numbers (unused)
boolean   $noHyphens:  Exclude domains with hyphens (unused)
boolean   $noIDN:  Exclude IDN domains (unused)
string   $tld:  Domain extension (unused)
string   $language:  Domain language (unused)
int   $what:  What listings are to be shown (one of the SHOW_* constants)
int   $endtime:  Endtime
boolean   $onlyIDN:  Exclude all non idn domains
string   $market:  Domain market
boolean   $onlyWithOffers:  Show only domains which received offers

API Tags:
Return:  Listing count
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getMarketplaceOptions  [line 6060]

  MarketOptions getMarketplaceOptions( [string $email = null], [string $key = null]  )

Retrieves user marketplace options

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Marketplace options
Access:  public


[ Top ]
getMarketplacePortals  [line 7952]

  Dictionary[] getMarketplacePortals( [string $email = null], [string $key = null]  )

Get available marketplace portals

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Dictionary values
Access:  public


[ Top ]
getMyAuctions  [line 1332]

  Auction[] getMyAuctions( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [int $range = 0]  )

Retrieves the list of user auctions.

Retrieves the number of active auctions listed by the user.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
int   $range:  Which auctions to show (one of the MYAUCTIONS_* constants)

API Tags:
Return:  Auction list
Access:  public


[ Top ]
getMyAuctionsCount  [line 1289]

  int getMyAuctionsCount( [string $email = null], [string $key = null], [int $range = self::MYAUCTIONS_ALL]  )

Gets the number of active auctions listed by the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $range:  Which auctions to show (one of the MYAUCTIONS_* constants)

API Tags:
Return:  Number of auctions
Access:  public


[ Top ]
getMyBalance  [line 224]

  float getMyBalance( string $email, string $key  )

Returns current balance on the account.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Account balance
Access:  public

Redefinition of:
API::getMyBalance()
Returns current balance on the account.

[ Top ]
getMyBids  [line 1248]

  Auction[] getMyBids( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE]  )

Retrieves the list of auctions where the user is bidding or watching.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size

API Tags:
Return:  Auction list
Access:  public


[ Top ]
getMyBidsCount  [line 1230]

  int getMyBidsCount( [string $email = null], [string $key = null]  )

Gets the number of auctions where the user is bidding or watching.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of auctions
Access:  public


[ Top ]
getMyCatalogs  [line 6876]

  Catalog[] getMyCatalogs( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE]  )

Returns user's catalogs

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size

API Tags:
Return:  Array of catalogs
Access:  public


[ Top ]
getMyCatalogsCount  [line 6895]

  int getMyCatalogsCount( [string $email = null], [string $key = null]  )

Returns number of user's catalogs

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of catalogs
Access:  public


[ Top ]
getMyCounterOffers  [line 3087]

  CounterOffer[] getMyCounterOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ""]  )

Retrieves the list of submitted counteroffers.

The seller can propose a higher price to the buyer, and such proposition is called a counteroffer.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)

API Tags:
Return:  Counteroffer list
Access:  public


[ Top ]
getMyCounterOffersCount  [line 3066]

  int getMyCounterOffersCount( [string $email = null], [string $key = null]  )

Gets the number of submitted counteroffers.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of counter offers
Access:  public


[ Top ]
getMyCurrency  [line 235]

  string getMyCurrency( string $email, string $key  )

Returns the account currency.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Account currency
Access:  public

Redefinition of:
API::getMyCurrency()
Returns the account currency.

[ Top ]
getMyMaximumBid  [line 1270]

  AuctionBid getMyMaximumBid( [string $email = null], [string $key = null], int $auction_id  )

Retrieves the maximum user bid in a given auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $auction_id:  Auction ID

API Tags:
Return:  The highest bid
Access:  public


[ Top ]
getMyOffers  [line 2999]

  Offer[] getMyOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ""], [string $filter_status = ''], [string $filter_name = '']  )

Retrieves the list of submitted offers.

The list contains purchase offers that have been submitted by the user, for domains being sold by other users.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)
string   $filter_status:  Filter offers status ('A', 'B', 'O', 'E', 'N', 'C')
string   $filter_name:  Filter offers by domain name

API Tags:
Return:  Offer list
Access:  public


[ Top ]
getMyOffersCount  [line 2964]

  int getMyOffersCount( [string $email = null], [string $key = null], [string $filter_status = ''], [string $filter_name = ''], string 4  )

Gets the number of submitted offers.

Parameters:
string   4:  User authorization code
string   $email:  User email
string   $key:  User authorization code
string   $filter_status:  Filter offers status ('A', 'B', 'O', 'E', 'N', 'C')
string   $filter_name:  Filter offers by domain name

API Tags:
Return:  Number of my offers
Access:  public


[ Top ]
getMySecurityDeposit  [line 284]

  float getMySecurityDeposit( string $email, string $key  )

Returns current security deposit on the account.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Security deposit
Access:  public


[ Top ]
getMyUserId  [line 213]

  string getMyUserId( string $email, string $key  )

Returns the identifier of the logged-in user.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  User identifier
Access:  public

Redefinition of:
API::getMyUserId()
Returns the identifier of the logged-in user.

[ Top ]
getNewEvents  [line 1169]

  Event[] getNewEvents( [string $email = null], [string $key = null], string $type, int $count  )

Retrieves unseen events that occurred on the marketplace.

For a detailed discussion of events, see the API Events document.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $type:  Event type
int   $count:  Number of events to retrieve

API Tags:
Return:  Event list
Access:  public


[ Top ]
getOfferInfo  [line 4439]

  Offer getOfferInfo( string $email, string $key, int $offerId  )

Retrieves information about a domain purchase offer.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $offerId:  Offer id

API Tags:
Return:  Offer data
Access:  public

Information Tags:
Throws:  Exceptions: 10102, 11300 (see API Error Codes)

[ Top ]
getPastAuctions  [line 1456]

  Auction[] getPastAuctions( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [int $range = self::MYAUCTIONS_ALL], [boolean $topay = false]  )

Retrieves the list of finished auctions of the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
int   $range:  Which auctions to show (one of the MYAUCTIONS_* constants)
boolean   $topay:  Show auctions with active payment

API Tags:
Return:  Auction list
Access:  public


[ Top ]
getPastAuctionsCount  [line 1410]

  int getPastAuctionsCount( [string $email = null], [string $key = null], [int $range = self::MYAUCTIONS_ALL], [boolean $topay = false]  )

Gets the number of finished auctions of the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $range:  Which auctions to show (one of the MYAUCTIONS_* constants)
boolean   $topay:  Show only domains with active payment

API Tags:
Return:  Number of finished auctions
Access:  public


[ Top ]
getPastCounterOffers  [line 3320]

  CounterOffer[] getPastCounterOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ""]  )

Retrieves the list of past received counteroffers.

The seller can propose a higher price to the buyer, and such proposition is called a counteroffer. Fuction retrieves counteroffer from seller to buyer (for buyer).

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)

API Tags:
Return:  Counteroffer list
Access:  public


[ Top ]
getPastCounterOffersCount  [line 3297]

  int getPastCounterOffersCount( [string $email = null], [string $key = null]  )

Gets the number of past received counteroffers.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of counter offers
Access:  public


[ Top ]
getPastFirstMinuteAuctions  [line 1110]

  Auction[] getPastFirstMinuteAuctions( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE]  )

Retrieves the list of finished filtered by First Minute auctions for user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size

API Tags:
Return:  Auction list
Access:  public


[ Top ]
getPastOffers  [line 2905]

  Offer[] getPastOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ""]  )

Retrieves the list of inactive received offers.

The list contains offers that have been received, but are no longer active. It includes offers that have been acted upon, and offers that have expired.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)

API Tags:
Return:  Offer list
Access:  public


[ Top ]
getPastOffersCount  [line 2883]

  int getPastOffersCount( [string $email = null], [string $key = null]  )

Gets the number of inactive received offers.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of past offers
Access:  public


[ Top ]
getPrice  [line 384]

  float getPrice( string $email, string $key, string $type, string $currency, string $portal  )

Returns a price for specified service on the marketplace

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $type:  Operation type
string   $currency:  Currency
string   $portal:  Marketplace portal

API Tags:
Return:  Operation price
Access:  public


[ Top ]
getProposedOffers  [line 3411]

  ProposedOffer[] getProposedOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $name = '']  )

Retrieves the list of active offers for purchase of proposed domains (unpaid in private auction)

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $name:  Optional domain name (for fetching price for single offer)

API Tags:
Return:  Offer list
Access:  public


[ Top ]
getProposedOffersCount  [line 3392]

  int getProposedOffersCount( [string $email = null], [string $key = null]  )

Gets the number of active offers for purchase of blocked domains.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of received offers
Access:  public


[ Top ]
getReceivedCounterOffers  [line 3216]

  CounterOffer[] getReceivedCounterOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ""], [string $search_domain = '']  )

Retrieves the list of received counteroffers.

The seller can propose a higher price to the buyer, and such proposition is called a counteroffer. Fuction retrieves counteroffer from seller to buyer (for buyer).

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)
string   $search_domain:  Return received counter offers for single domain

API Tags:
Return:  Counteroffer list
Access:  public


[ Top ]
getReceivedCounterOffersCount  [line 3192]

  int getReceivedCounterOffersCount( [string $email = null], [string $key = null]  )

Gets the number of received counteroffers.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of counter offers
Access:  public


[ Top ]
getReceivedOffers  [line 2827]

  Offer[] getReceivedOffers( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [string $order = ""]  )

Retrieves the list of active received offers.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
string   $order:  List sorting (see the API Quick Start Guide document for details)

API Tags:
Return:  Offer list
Access:  public


[ Top ]
getReceivedOffersCount  [line 2808]

  int getReceivedOffersCount( [string $email = null], [string $key = null]  )

Gets the number of active received offers.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of received offers
Access:  public


[ Top ]
getRegisteredDomains  [line 6019]

  Domain[] getRegisteredDomains( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE], [boolean $nonLockedOnly = false]  )

Retrieve the list of domains registered by the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size
boolean   $nonLockedOnly:  Lists only domains available to be sold

API Tags:
Return:  Domain list
Access:  public


[ Top ]
getRegisteredDomainsCount  [line 6042]

  int getRegisteredDomainsCount( [string $email = null], [string $key = null], [boolean $nonLockedOnly = false]  )

Retrieve number of domains registered by the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $nonLockedOnly:  Lists only domains available to be sold

API Tags:
Return:  Number of registered domains
Access:  public


[ Top ]
getRequiredDeposit  [line 6988]

  boolean getRequiredDeposit( [string $email = null], [string $key = null], string $name  )

Checks if deposit is required for given domain.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  True if deposit is required
Access:  public

Information Tags:
Throws:  Exceptions: 11200 (see API Error Codes)

[ Top ]
getSellerNick  [line 5851]

  string getSellerNick( [string $email = null], [string $key = null], [string $memberId = '']  )

Gets user marketplace nick used for selling domains.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $memberId:  User identifier (if empty, returns nick of current user)

API Tags:
Return:  User nick
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getSellerRating  [line 6947]

  SellerRating getSellerRating( [string $email = null], [string $key = null], string $sellerId  )

Gets seller rating information.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $sellerId:  Seller identifier

API Tags:
Return:  Rating information
Access:  public

Information Tags:
Throws:  Exceptions: 11400 (see API Error Codes)

[ Top ]
getSoldDomains  [line 1390]

  Operation[] getSoldDomains( [string $email = null], [string $key = null], [int $start = 0], [int $size = self::DEFAULT_SIZE]  )

Retrieves the list of domains sold by the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $start:  List start (for paging)
int   $size:  Page size

API Tags:
Return:  Operation list
Access:  public


[ Top ]
getSoldDomainsCount  [line 1372]

  int getSoldDomainsCount( [string $email = null], [string $key = null]  )

Gets the number of domains sold by the user.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Number of finished auctions
Access:  public


[ Top ]
getUsedSecurityDeposit  [line 297]

  float getUsedSecurityDeposit( string $email, string $key  )

Returns currently used security deposit on the account.

Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Return:  Security deposit
Access:  public


[ Top ]
groupDomainsForSale  [line 7834]

  boolean groupDomainsForSale( [string $email = null], [string $key = null], boolean $check, string $domains  )

Creates a group of domains to be sold together on the marketplace.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $domains:  Domain names (separated by slash signs)

API Tags:
Access:  public


[ Top ]
importDomainsForSale  [line 4919]

  OperationResult[] importDomainsForSale( [string $email = null], [string $key = null], [boolean $check = false], string[] $names  )

Imports external domains for sale on user account.

Domains not registered with AfterMarket.pl need to be imported to the marketplace. This function will import these domains to user account.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string[]   $names:  Array of domain names

API Tags:
Return:  Array of results for each domain. Result code can be one of IMPORT_RESULT_ constant values.
Access:  public

Information Tags:
Throws:  Exceptions: 11000 (see API Error Codes)

[ Top ]
inviteBidder  [line 1943]

  boolean inviteBidder( string $email, string $key, boolean $check, int $auctionId, string $bidderId  )

Invites a bidder to a private auction

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier
string   $bidderId:  Bidder auction nick or email

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10307, 11108, 11109 (see API Error Codes)

[ Top ]
keepAlive  [line 191]

  boolean keepAlive( string $email, string $key  )

Null function - does nothing.

This function can be used as a "keep alive" mechanism to prevent the authentication session from expiring.

 Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Access:  public

Redefinition of:
API::keepAlive()
Null function - does nothing.

[ Top ]
login  [line 165]

  string login( string $email, string $password, [string $lang = "pl"]  )

Creates a new session for specified user, returns session authorization code.

This function is used to open an authenticated API session. Upon succesful execution, an API authorization code is returned, which must be used in all subsequent API calls.

 Parameters:
string   $email:  User email
string   $password:  User password
string   $lang:  Session language

API Tags:
Return:  Authorization code
Access:  public

Information Tags:
Throws:  Exceptions: 10002, 10004, 10006 (see ErrorCodesDM.pkg)
Redefinition of:
API::login()
Creates a new session for specified user, returns session authorization code.

[ Top ]
logout  [line 178]

  boolean logout( string $email, string $key  )

Closes user session

This function terminates the authentication session created by the login() function.

 Parameters:
string   $email:  User email
string   $key:  User authorization code

API Tags:
Access:  public

Redefinition of:
API::logout()
Closes user session

[ Top ]
makeOffer  [line 2417]

  RequiredDeposit makeOffer( string $email, string $key, boolean $check, string $name, int $price, string $currency, [string $message = ""], [boolean $allowAuction = true]  )

Makes a purchase offer for a domain on the marketplace.

A binding purchase offer is entered for the specified domain, and the seller is notifed via email so that they can act on the offer.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
int   $price:  Offer amount
string   $currency:  Offer currency
string   $message:  Optional message to seller
boolean   $allowAuction:  The seller will be allowed to start an auction basing on this offer

API Tags:
Return:  Object containing information about the required deposit
Access:  public

Information Tags:
Throws:  Exceptions: 10300, 10301, 10306, 11109, 11200, 11202, 11203 (see API Error Codes)

[ Top ]
nextBid  [line 2103]

  int nextBid( string $email, string $key, int $amount, string $currency  )

Returns next possible bid value in an auction.

This function returns the smallest amount that can be bid in an auction, given its current price.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $amount:  Bid amount
string   $currency:  Bid currency

API Tags:
Return:  Next bid amount
Access:  public


[ Top ]
placeBid  [line 2163]

  int placeBid( string $email, string $key, boolean $check, int $auctionId, int $price, string $currency  )

Places a bid in an auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier
int   $price:  Bid amount
string   $currency:  Bid currency

API Tags:
Return:  Result code - one of the PLACE_BID_ constants
Access:  public

Information Tags:
Throws:  Exceptions: 10201, 10202, 10300, 10303, 10304, 10306, 11106, 11109, 11115, 11116, 11117, 11119, 11120 (see API Error Codes)

[ Top ]
promoteAuction  [line 1746]

  boolean promoteAuction( string $email, string $key, boolean $check, int $auctionId, int $type  )

Promotes the auction on the main page or category page.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier
int   $type:  Promotion type - one of the PROMOTE_AUCTION_ constants

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10201, 10302, 11114, 11121 (see API Error Codes)

[ Top ]
rejectOffer  [line 3476]

  boolean rejectOffer( [string $email = null], [string $key = null], [boolean $check = false], int $offerId  )

Rejects a received offer.

The domain purchase offer is rejected and becomes inactive.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $offerId:  Offer identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10102, 11008, 11300 (see API Error Codes)

[ Top ]
removeDomainFromCatch  [line 6381]

  boolean removeDomainFromCatch( [string $email = null], [string $key = null], string $domain  )

Delete domain from catch

Parameters:
string   $email:  SOAP-API auth email
string   $key:  SOAP-API auth session code
string   $domain:  Domain name

API Tags:
Access:  public


[ Top ]
removeDomainsFromCatalog  [line 6742]

  OperationResult[] removeDomainsFromCatalog( [string $email = null], [string $key = null], [boolean $check = false], int $catalogId, string[] $names  )

Removes domains from a marketplace catalog.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $catalogId:  Catalog identifier
string[]   $names:  Domain names to be removed from the catalog

API Tags:
Return:  Array of results for each domain. Result code can be one of CATALOG_RESULT_ constant values.
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11000, 11208 (see API Error Codes)

[ Top ]
renameCatalog  [line 6643]

  boolean renameCatalog( [string $email = null], [string $key = null], [boolean $check = false], int $id, string $name  )

Renames a marketplace catalog

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $id:  Catalog identifier
string   $name:  New catalog name

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10104, 11207, 11208, 11209 (see API Error Codes)

[ Top ]
retrieveAuctionAttachment  [line 7561]

  AttachmentContents[] retrieveAuctionAttachment( [string $email = null], [string $key = null], int $auctionId, int $attachmentId  )

Get auction attachment file contents and file name

Parameters:
string   $email:  User email
string   $key:  User authorization code
int   $auctionId:  auctionId
int   $attachmentId:  attachmentId

API Tags:
Return:  AttachmentContents
Access:  public

Information Tags:
Throws:  Exceptions: 10101, 11107, 11111, 11500, 11501 (see API Error Codes)

[ Top ]
retrieveListingAttachment  [line 7523]

  AttachmentContents[] retrieveListingAttachment( [string $email = null], [string $key = null], string $name, int $attachmentId  )

Retrive sale attachment file contents and file name

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name
int   $attachmentId:  attachmentId

API Tags:
Return:  AttachmentContents
Access:  public

Information Tags:
Throws:  Exceptions: 11200, 10103, 11501, 11500 (see API Error Codes)

[ Top ]
setAuctionDescription  [line 7074]

  void setAuctionDescription( [string $email = null], [string $key = null], [boolean $check = false], string $auctionId, string $type, [string $description = '']  )

Add description to auction

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $auctionId:  auctionId
string   $type:  Description type
string   $description:  Description content

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10101, 11107, 11111 (see API Error Codes)

[ Top ]
setBuyerNick  [line 5883]

  boolean setBuyerNick( [string $email = null], [string $key = null], [boolean $check = false], string $auctionid  )

Sets marketplace nick for domain buying

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $auctionid:  Nick for domain buying

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10308, 11120, 11401 (see API Error Codes)

[ Top ]
setDomainCatchPriority  [line 6441]

  boolean setDomainCatchPriority( [string $email = null], [string $key = null], string $domain, boolean $priority  )

Set catch priority for a domain

Parameters:
string   $email:  SOAP-API auth email
string   $key:  SOAP-API auth session code
string   $domain:  Domain name
boolean   $priority:  Catch priority

API Tags:
Access:  public


[ Top ]
setDomainForSale  [line 5224]

  Listing setDomainForSale( [string $email = null], [string $key = null], [boolean $check = false], string $name, boolean $active, string $cat1, string $cat2, int $price, int $minPrice, string $currency, [string $language = ""], [string $cat3 = ""], [string $cat4 = ""], [int $priceReseller = 0], [string $portal = ""]  )

Sets the price of a domain offered for sale.

NOTE! This function may adjust the domain prices if they are too high. Therefore you must always check the returned Listing object to see what prices have been set.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
boolean   $active:  Set the domain for sale
string   $cat1:  Category 1 identifier
string   $cat2:  Category 2 identifier
int   $price:  Buy It Now price
int   $minPrice:  Minimum price
string   $currency:  Price currency
string   $language:  Domain language (unused)
string   $cat3:  Third category
string   $cat4:  Fourth category
int   $priceReseller:  Price reseller
string   $portal:  Portal where the auction will be visible

API Tags:
Return:  the marketplace listing as modified by the function call
Access:  public

Information Tags:
Throws:  Exceptions: 11005, 11200, 11206 (see API Error Codes)

[ Top ]
setDomainForSaleNote  [line 4353]

  boolean setDomainForSaleNote( [string $email = null], [string $key = null], [boolean $check = false], string $name, string $note  )

Sets a note for marketplace listing.

A note is a textual description added to the marketplace listing. It allows the seller to post additional information pertaining to the domain.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
string   $note:  New note text

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10103, 11200 (see API Error Codes)

[ Top ]
setListingDescription  [line 7019]

  void setListingDescription( [string $email = null], [string $key = null], [boolean $check = false], string $name, string $type, [string $description = '']  )

Add description to domain for sale

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $name:  Domain name
string   $type:  Type of description
string   $description:  Description content

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 11200, 10103 (see API Error Codes)

[ Top ]
setListingOptions  [line 6220]

  boolean setListingOptions( [string $email = null], [string $key = null], string $name, [boolean $check = false], [int $showDomainInfo = 0], [int $showDomainTraffic = 0]  )

Sets user marketplace listing options.

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Listing domain name
boolean   $check:  If true only parameter validation will be performed
int   $showDomainInfo:  Show detailed domain information (PageRank, Alexa, ...) [0 = False, 1 = True, -1 = Use default from marketplace options]
int   $showDomainTraffic:  Show detailed domain traffic information [0 = False, 1 = True, -1 = Use default from marketplace options]

API Tags:
Access:  public


[ Top ]
setMarketplaceOptions  [line 6100]

  boolean setMarketplaceOptions( [string $email = null], [string $key = null], [boolean $check = false], boolean $showNick, boolean $showPortfolioLink, boolean $showEmail, boolean $requireSecurityDeposits, boolean $newBidNotify, boolean $showCategories, boolean $showDomainInfo, boolean $showDomainTraffic, boolean $showMyCategories, [boolean $unused1 = false], [boolean $unused2 = false], [boolean $unused3 = false], boolean 15  )

Sets user marketplace options.

Parameters:
boolean   15:  Unused (must be false)
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  If true only parameter validation will be performed
boolean   $showNick:  Show user's seller nick on the listings
boolean   $showPortfolioLink:  Show link to user's domain portfolio on the listings
boolean   $showEmail:  Show link to contact user via email on the listings
boolean   $requireSecurityDeposits:  Require security deposits from people buying user's domains on the marketplace
boolean   $newBidNotify:  Inform user about new bids in his auctions
boolean   $showCategories:  Categories links to my domain list
boolean   $showDomainInfo:  Show domain info
boolean   $showDomainTraffic:  Show domain traffic
boolean   $showMyCategories:  Show categories
boolean   $unused1:  Unused (must be false)
boolean   $unused2:  Unused (must be false)
boolean   $unused3:  Unused (must be false)

API Tags:
Access:  public


[ Top ]
setMySecurityDeposit  [line 5967]

  boolean setMySecurityDeposit( [string $email = null], [string $key = null], [boolean $check = false], int $operation, int $amount, string $currency  )

Sets security deposit amount.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $operation:  Operation type - one of SECURITY_DEPOSIT_ constants
int   $amount:  Transfer amount
string   $currency:  deposit currency

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10200, 10201, 10300, 10302, 10306 (see API Error Codes)

[ Top ]
setSellerNick  [line 5925]

  boolean setSellerNick( [string $email = null], [string $key = null], [boolean $check = false], string $auctionid  )

Sets marketplace nick for domain selleing

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $auctionid:  Nick for domain selling

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10308, 11120, 11401 (see API Error Codes)

[ Top ]
toIDN  [line 323]

  string toIDN( string $email, string $key, string $name  )

Converts Punycode ASCII domain name into UTF form

Parameters:
string   $email:  User email
string   $key:  User authorization code
string   $name:  Domain name

API Tags:
Return:  Converted name
Access:  public


[ Top ]
ungroupDomainsForSale  [line 7915]

  boolean ungroupDomainsForSale( [string $email = null], [string $key = null], boolean $check, string $domains  )

Creates a group of domains to be sold together on the marketplace.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
string   $domains:  Domain names (separated by slash signs)

API Tags:
Access:  public


[ Top ]
uninviteBidder  [line 2052]

  boolean uninviteBidder( string $email, string $key, boolean $check, int $auctionId, string $bidderId  )

Removes bidder invitation from a private auction.

Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $auctionId:  Auction identifier
string   $bidderId:  Bidder identifier or email

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 11110 (see API Error Codes)

[ Top ]
withdrawOffer  [line 3528]

  boolean withdrawOffer( [string $email = null], [string $key = null], [boolean $check = false], int $offerId  )

Withdraws a submitted offer.

The domain purchase offer is withdrawn and becomes inactive.

 Parameters:
string   $email:  User email
string   $key:  User authorization code
boolean   $check:  Only check for parameter correctness
int   $offerId:  Offer identifier

API Tags:
Access:  public

Information Tags:
Throws:  Exceptions: 10102, 11008, 11300, 11301 (see API Error Codes)

[ Top ]
Constants
Class Overview | Constants Summary | Constants Detail | Inherited Properties, Constants, and Methods | Method Summary | Methods Detail
AUCTIONS_BIDS_ANY = 0 [line 111]

Show all auctions


[ Top ]
AUCTIONS_BIDS_NO_OFFERS = 2 [line 115]

Show auctions without offers


[ Top ]
AUCTIONS_BIDS_OFFERS = 1 [line 113]

Show auctions with offers


[ Top ]
CATALOG_RESULT_ALREADY_ADDED = 2 [line 128]

Domain is already listed in catalog


[ Top ]
CATALOG_RESULT_ALREADY_REMOVED = 3 [line 130]

Domain is already removed from catalog


[ Top ]
CATALOG_RESULT_NO_DOMAIN = 1 [line 126]

Domain is not listed on your acocunt for sale


[ Top ]
CATALOG_RESULT_OK = 0 [line 124]

Domain successfully added/removed from catalog


[ Top ]
FOR_SALE_WHAT_ALL = 0 [line 104]

Show all domain types


[ Top ]
FOR_SALE_WHAT_FOR_SALE = 1 [line 106]

Show domains set for sale


[ Top ]
FOR_SALE_WHAT_NOT_FOR_SALE = 2 [line 108]

Show domains not for sale


[ Top ]
FOR_SALE_WHERE_ALL = 0 [line 95]

Show all domain types


[ Top ]
FOR_SALE_WHERE_EXTERNAL = 2 [line 99]

Show pl domains


[ Top ]
FOR_SALE_WHERE_GROUP = 3 [line 101]

Show pl domains


[ Top ]
FOR_SALE_WHERE_INTERNAL = 1 [line 97]

Show domains registered with Dropped.pl


[ Top ]
IMPORT_RESULT_ALREADY_ADDED = 1 [line 84]

Domain has been already imported


[ Top ]
IMPORT_RESULT_BELONGS_TO_ANOTHER_USER = 3 [line 88]

Domain belongs to another user


[ Top ]
IMPORT_RESULT_NOT_ALLOWED = 4 [line 90]

User doesn't have permission to import external domain


[ Top ]
IMPORT_RESULT_REGISTERED_WITH_DROPPED = 2 [line 86]

Domain is already registered with Dropped.pl


[ Top ]
IMPORT_RESULT_SUCCESS = 0 [line 82]

Domain was imported successfuly


[ Top ]
IMPORT_RESULT_WRONG_DOMAIN_TYPE = 5 [line 92]

Domain of this TLD cannot be imported


[ Top ]
MYAUCTIONS_ALL = 0 [line 47]

Return all auctions


[ Top ]
MYAUCTIONS_FM = 3 [line 53]

Return First Minute auctions


[ Top ]
MYAUCTIONS_LM = 2 [line 51]

Return Last Minute auctions


[ Top ]
MYAUCTIONS_NORMAL = 1 [line 49]

Return regular auctions


[ Top ]
MYAUCTIONS_WITHOUT_OFFERS = 5 [line 57]

Return auctions without bids


[ Top ]
MYAUCTIONS_WITH_OFFERS = 4 [line 55]

Return auctions with bids


[ Top ]
PLACE_BID_HIGHEST = 1 [line 60]

Informs that the placed bid was highest


[ Top ]
PLACE_BID_NOT_HIGHEST = 2 [line 62]

Informs that the placed bid was not highest


[ Top ]
PLACE_BID_RESERVE = 3 [line 64]

Informs that the placed bid was highest but below reserve price


[ Top ]
PROMOTE_AUCTION_CATEGORY = 1 [line 67]

Informs that the placed bid was highest


[ Top ]
PROMOTE_AUCTION_HOMEPAGE = 2 [line 69]

Informs that the placed bid was not highest


[ Top ]
SECURITY_DEPOSIT_IN = 0 [line 119]

Transfer funds into security deposit


[ Top ]
SECURITY_DEPOSIT_OUT = 1 [line 121]

Transfer funds from securtiy deposit into your account


[ Top ]
SHOW_LISTINGS_AND_AUCTIONS = 0 [line 72]

Shows both listings and auctions


[ Top ]
SHOW_ONLY_AUCTIONS = 2 [line 76]

Shows only auctions


[ Top ]
SHOW_ONLY_LISTINGS = 1 [line 74]

Shows only listings


[ Top ]
Documentation generated on Thu, 18 Aug 2011 10:03:42 +0200 by phpDocumentor 1.4.3