How to obtain a list of registered bidder types for a user for a particular auction

To obtain a list of bidder types that the user is registered with for a particular auction, use the URL below.

 

 Method URL
 GET  https://api.fairwarningsoftware.com/v1.1.1/user/bidder/[user-id]/[auction-id]

 

If successful, the response will contain the  user details, or else it will contain an error.

 

 

 Status Response
 200

{
    "bidder_numbers": {[
        "bidder_number_info": {
            "bidder_number": <bidder_number>,
            "bidder_type_id": <bidder_type_id>,
            "type_name": <type_name>

        }
    ]}
}

401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
404  {"error":"API method ([method]) not found."}
500  {"error": <custom error>}
 Status Response
 200 <?xml version="1.0"?>
<response>
  <bidder_numbers>
      <bidder_number_info>
            <bidder_number>[bidder_number]</bidder_number>
            <bidder_type_id>[bidder_type_id]</bidder_type_id>
            <type_name>[type_name]</type_name>
        </bidder_number_info>
    </bidder_numbers>
</response>
401 <?xml version="1.0"?> <response><error>The API keys provided are invalid</error></response>
403

<?xml version="1.0"?> <response><error>API keys are missing.</error></response>

404

<?xml version="1.0"?> <response><error>API method ([method]) not found.</error></response>

500 <?xml version="1.0"?> <response><error>[custom error]</error></response>

 

 Field  Type Description
bidder_numbers object Contains a list of bidder_number_info objects
bidder_number_info object Contains information about the bidder number assigned to the user
bidder_number string The number assigned to the bidder for the auction for this particular bidder type
bidder_type_id int The bidder type ID associated with this bidder number
type_name string The name of the bidder type for this bidder type ID