Skip to main content

Reference Data List

Description​

The Reference Data List 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.

The API must be structured correctly and have the correct security in place. See our document Troubleshooting.

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

Making a request​

URL​

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

HTTP Method​

GET

Headers​

KeyValue
BDXAPI_NAMEBidlogix API Signature
Content-Typeapplication/json

Path Parameters​

ParameterValue
clientIDID of the client you wish to view data for
type_of_reference_datainclude countries, continents, currencies, categories or timezones to return the relevant information. These parameters can be added in combination, separated by a commma

Also see API Introduction.

Examples​

Call

https://hove.eu-west-2.bidjs.com/auction-mgt/bdxapi/reference/continents?clientId=302

Response

{
    "@class": ".DataPushPayload",
    "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": "302"
}

Errors​

codeexample
401 UNAUTHORIZED{ error : "Log in" }
422 Unprocessable Entry{ error : ["<field_name>"] }