Skip to main content

GET Bidding Template by ID

Overview


The following table contains important information about the GET method in regards to receiving the bidding templates by ID.

GET Bidding Template by ID
MethodGET
URL or Endpoint/api/projects/projectId/bidding-templates/id
HeadersAuthorization
ParametersprojectId, id
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.
idYesstringUnique id of the bidding template.

Request Body

The request does not contain a request body

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"name": "Mall Bidder Update ",
"publicId": "bqevmvts",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 41,
"biddingTemplatePublicId": "bqevmvts",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 16,
"biddingTemplateBidderId": 41,
"bidParamId": 16,
"value": "asddsa"
},
{
"id": 17,
"biddingTemplateBidderId": 41,
"bidParamId": 17,
"value": "asddsa"
}
]
}
]
},
"resultInfo": null,
"statusCode": 200
}

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
namestringThe name of the bidding template
publicIdstringThe id of the bidder.
mediaOptionIdinteger($int32)The id of the media option.
biddingTemplateBiddersarray[Object]Returns the bidding template bidders as an array of objects.
idinteger($int32)The id of the bidder.
biddingTemplatePublicIdstringThe id of the bidder.
bidderIdinteger($int32)The id of the bidder.
namestringThe name of the bidder
bidParamValuesarray[Object]Returns the bidder parameter values as an array of objects.
idinteger($int32)The id of the bidder parameter value.
biddingTemplateBidderIdinteger($int32)The id of the bidding template bidder.
bidParamIdinteger($int32)The id of the bidder parameter value.
valuestringThe value of the bidder parameter.
resultInfostringReturns extra information about the result.
statusCodeinteger($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