GET All Select Options

Overview

---

The following table contains important information about the GET method in regards to receiving all select options.

GET All Select Options
Method	GET
URL or Endpoint	/api/projects/projectId/ad-schedules/select-options
Headers	Authorization
Parameters	projectId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "adManagerOptions": [
      {
        "id": 1,
        "Value": "VAST"
      },
      {
        "id": 2,
        "Value": "VMAP"
      }
    ],
    "vpaidModeOptions": [
      {
        "id": 2,
        "name": "Insecure"
      },
      {
        "id": 4,
        "name": "Disabled"
      }
    ],
    "adSeenOnSubsequentVisitOptions": [
      {
        "id": 1,
        "name": "Play the preroll break"
      },
      {
        "id": 2,
        "name": "Do not play ads"
      },
      {
        "id": 3,
        "name": "Play a preroll and any skipped midroll"
      }
    ],
    "adBreakTypeOptions": [
      {
        "id": 1,
        "name": "Preroll"
      },
      {
        "id": 2,
        "name": "Midroll"
      },
      {
        "id": 3,
        "name": "Postroll"
      }
    ],
    "breakTimingTypeOptions": [
      {
        "id": 1,
        "name": "Seconds into Video"
      },
      {
        "id": 3,
        "name": "% of Video"
      }
    ],
    "biddingTemplateOptions": [
      {
        "name": "Bidding type 1 - u ",
        "publicId": "bqevmvtn",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "njomza",
        "publicId": "bqevmvto",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "Mall Bidder Update ",
        "publicId": "bqevmvts",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "Bidding type 1",
        "publicId": "bqevmvtz",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "test idding 2 ad partners - update",
        "publicId": "bqevmvue",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "test bidding temp",
        "publicId": "bqevmvuf",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "Bidding template test add",
        "publicId": "bqevmvug",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "ylber test bidding template",
        "publicId": "bqevmvuh",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "Test Player Bidding",
        "publicId": "bqevmvtl",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      },
      {
        "name": "Gentiana",
        "publicId": "bqevmvtm",
        "mediationOptionId": 1,
        "biddingTemplateBidders": []
      }
    ]
  },
  "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 will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
adManager	Object	Returns the ad manager option.
id	integer($int32)	Id of the ad manager type.
name	string	Name of the ad manager type.
vpaidModeOptions	array[Object]	Returns the VPAID mode options as an array of objects.
id	integer($int32)	Id of the ad VPAID mode option.
name	string	Name of the VPAID mode option.
adSeenOnSubsequentOptions	array[Object]	Returns the subsequent visit options.
id	integer($int32)	Id of the subsequent visit option.
name	string	Name of the subsequent visit option.
id	integer($int32)	Id of the ad break type.
name	string	Name of the ad break type.
breakTimingOptions	array[Object]	Returns the break timing options as an array of objects.
id	integer($int32)	Id of the break timing option.
name	string	Name of the break timing option.
biddingTemplateOptions	array[Object]	Returns the bidding template options as an array of objects.
name	string	The name of the bidding type.
publicId	string	The id of the bidding type.
mediationOptionId	integer($int32)	The id of the mediation option.
biddingTemplateBidders	array[Object]	Returns the template bidders as an array of objects.
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