Description

The Auction Data call reports on auction reference data within the Bidlogix system. For example, this will provide a list of auctions that are currently live in bidlogix, including the number of items in this auction, its start time, default currency, etc. It uses Http Method: GET. 

The API must be structured correctly and have the correct security in place. See also Common API Errors

See Status Codes and Common Data documents for more information on results. 


URL

https://your_bidlogix_domain/auction-mgt/bdxapi/auctions/{auctioneerId}[/{type}]?clientId=your_bidlogix_client_id


Key

{auctioneerId} : the id of an auctioneer.
{type} : optional parameter one of [timed, webcast, market]. 


Method

Http Method: GET


Security 

See API Security - Generating your Signature


Query String Parameters 

See String Query Parameters.


Success Response

Example 1: /auction-mgt/bdxapi/auctions/1?clientId=1

   "pushCode":"AUCTION_REFERENCE",

   "models":{ 

      "auctionReferenceModel":{ 

         "@class":".BackboneCollectionModel",

         "collection":[ 

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":1,

               "title":"The Marketplace",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1508544000000,

               "type":"MarketAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":2,

               "title":"Acme Test Auction 1",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":2,

               "primaryDate":1477526400000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":3,

               "title":"Acme Test Auction 2",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":2,

               "primaryDate":1237813200000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":4,

               "title":"Acme Live 3",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1477526400000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":5,

               "title":"Acme Live 4",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1477526400000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":6,

               "title":"Selenium Live Test 1",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1477353600000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":7,

               "title":"Selenium Live Test 2",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1477699200000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":8,

               "title":"Selenium Live Test 5",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1477440000000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":9,

               "title":"Selenium Live Test 6",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1477440000000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":10,

               "title":"Selenium Test 3",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":2,

               "primaryDate":1477440000000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":11,

               "title":"Selenium Test 4",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":2,

               "primaryDate":1592661600000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":19,

               "title":"empty vanilla auction",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":2,

               "primaryDate":1477440000000,

               "type":"EventAuction",

               "locale":"1_1"

            },

            

               "@class":".auctionreference.AuctionReferenceModel",

               "id":149,

               "title":"Webcast Auction UK One",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerReferenceModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "live":false,

               "catalogue":false,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1476966600000,

               "type":"WebcastAuction",

               "locale":"1_1"

            }

         ]

      }

   },

   "webAppContext":"1"

}


Example 2: /auction-mgt/bdxapi/auctions/1/market?clientId=1

   "@class":".DataPushPayload",

   "pushCode":"AUCTION_REFERENCE",

   "models":{ 

      "auctionReferenceModel":{ 

         "@class":".BackboneCollectionModel",

         "collection":[ 

            

               "@class":".auctionapi.AuctionApiModel",

               "id":1,

               "title":"The Marketplace",

               "auctioneerReferenceModel":{ 

                  "@class":".AuctioneerApiModel",

                  "id":1,

                  "name":"Apex UK"

               },

               "currency":{ 

                  "@class":".CurrencyModel",

                  "id":2,

                  "name":"British Pound Sterling",

                  "code":"GBP",

                  "selected":false,

                  "symbol":"£"

               },

               "live":false,

               "webcasty":false,

               "marketplace":true,

               "salesTaxRequired":true,

               "buyersPremiumRequired":true,

               "itemCount":0,

               "statusId":4,

               "primaryDate":1510963200000,

               "type":"MarketAuction",

               "locale":"1_1",

               "hammerTaxRate":20,

               "bpTaxRate":20,

               "chargesTaxRate":20,

               "autoIncrementsActiveForTimedAuctions":false,

               "autoIncrementsActiveForWebcast":false,

               "location":{ 

                  "@class":".AddressModel",

                  "id":1,

                  "version":0,

                  "addressType":0,

                  "addressLine1":"55 High St",

                  "addressLine2":"Westhgate",

                  "addressLine3":"",

                  "addressLine4":"",

                  "city":"London",

                  "county":"",

                  "postcode":"N14 6LD",

                  "countryId":232,

                  "countryCode":"uk",

                  "countryName":"United Kingdom",

                  "continentId":1,

                  "continentCode":"EUR",

                  "latitude":null,

                  "longitude":null

               },

               "items":null

            }

         ]

      }

   },

   "webAppContext":"1"

}


Error Response

Code: 401 UNAUTHORIZED 

 Example: { error : "Log in" }

Code: 422 Unprocessable Entry 

Example: { error : ["<field_name>"] }