GET Bid Options as Select List

Overview

---

The following table contains information about the GET method for managing the proccess of retrieving all Bid Options as a list.

GET Bid Options as select list
Method	GET
URL or Endpoint	/api/bid-options/select-list
Headers	Authorization
Parameters	Not Applicable
Body	Not Applicable

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "name": "Send All Bids",
      "value": "Send All Bids",
      "description": null
    },
    {
      "id": 2,
      "name": "Send Top Price",
      "value": "Send Top Price",
      "description": null
    }
  ],
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from the back-end.
result	array[Object]	Returns an array of objects with bid options.
id	integer	Unique identifier of the bid option.
name	string	Name of the bid option (e.g., Send All Bids, Send Top Price).
value	string	Value of the bid option (e.g., Send All Bids, Send Top Price).
description	string	Description of the bid option (null if not provided).
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed