Description

The Fetch Reference Data call returns reference data objects from the bidlogix system - mainly useful in combination with other bidlogix api calls. For example, you could use this to call a list of countries used in the system, which would include information such as the country ID, it's full name and alphanumeric code, 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 for more information on results. 


URL

https://your_bidlogix_domain/auction-mgt/bdxapi/reference/{type_of_reference_data}?clientId=your_bidlogix_client_id


Key

{type_of_reference_data} :  is one of

  • countries

  • continents

  • currencies

  • categories

  • timezones

or a comma separated combination of any of them.


Method

Http Method: GET


Security

See Bidlogix API


Query String Parameters

See Query String Parameters


Success Response

e.g. https://your_bidlogix_domain/auction-mgt/bdxapi/reference/continents?clientId=139

Returns:

{ 

   "pushCode":"REFERENCEDATA",

   "models":{ 

      "referenceModel":{ 

         "@class":".reference.ReferenceDataModel",

         "referenceItemModelMap":{ 

            "continents":[ 

               { 

                  "@class":"com.bidlogix.scaffold.models.address.ContinentModel",

                  "id":5,

                  "name":"Africa",

                  "code":"AFR",

                  "selected":false

               },

               { 

                  "@class":"com.bidlogix.scaffold.models.address.ContinentModel",

                  "id":4,

                  "name":"Asia",

                  "code":"ASI",

                  "selected":false

               },

               { 

                  "@class":"com.bidlogix.scaffold.models.address.ContinentModel",

                  "id":1,

                  "name":"Europe",

                  "code":"EUR",

                  "selected":false

               },

               { 

                  "@class":"com.bidlogix.scaffold.models.address.ContinentModel",

                  "id":2,

                  "name":"North America",

                  "code":"NAM",

                  "selected":false

               },

               { 

                  "@class":"com.bidlogix.scaffold.models.address.ContinentModel",

                  "id":6,

                  "name":"Oceana",

                  "code":"OCE",

                  "selected":false

               },

               { 

                  "@class":"com.bidlogix.scaffold.models.address.ContinentModel",

                  "id":3,

                  "name":"South America",

                  "code":"SAM",

                  "selected":false

               }

            ]

         }

      }

   },

   "webAppContext":"1"

}


Error Response


Code: 401 UNAUTHORIZED 

 Example: { error : "Log in" }

Code: 422 Unprocessable Entry 

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