GET All Select Options

Overview

---

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

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 parameters is as follows:

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

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "adManagerOptions": [
      {
        "id": 0,
        "Value": "{Value}"
      }
    ],
    "vpaidModeOptions": [
      {
        "id": 0,
        "name": "{name}"
      }
    ],
    "adSeenOnSubsequentVisitOptions": [
      {
        "id": 0,
        "name": "{name}"
      }
    ],
    "adBreakTypeOptions": [
      {
        "id": 0,
        "name": "{name}"
      }
    ],
    "breakTimingTypeOptions": [
      {
        "id": 0,
        "name": "{name}"
      }
    ],
    "biddingTemplateOptions": [
      {
        "name": "{name}",
        "publicId": "{publicId}",
        "mediationOptionId": 0,
        "biddingTemplateBidders": [
          {
            "id": 0,
            "biddingTemplatePublicId": "{biddingTemplatePublicId}",
            "bidderAlias": "{bidderAlias}",
            "bidderId": 0,
            "name": "{name}",
            "bidderLogoPath": "{bidderLogoPath}",
            "bidParamValues": [
              {
                "id": 0,
                "biddingTemplateBidderId": 0,
                "bidParamId": 0,
                "value": "{value}",
                "placeholder": "{placeholder}"
              }
            ]
          }
        ]
      }
    ],
    "adScheduleTypeOptions": [
      {
        "id": 0,
        "name": "{name}",
        "value": "{value}",
        "description": "{description}"
      }
    ],
    "distributionMethodTypeOptions": [
      {
        "id": 0,
        "name": "{name}",
        "value": "{value}",
        "description": "{description}"
      }
    ],
    "midrollTypeOptions": [
      {
        "id": 0,
        "name": "{name}",
        "value": "{value}",
        "description": "{description}",
        "icon": "{icon}"
      }
    ],
    "playerTypeOptions": [
      {
        "id": 0,
        "name": "{name}",
        "value": "{value}",
        "description": "{description}"
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

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

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from back-end.
result	object	Returns the object containing all select option lists.
adManagerOptions	array[object]	Returns the available ad manager options.
vpaidModeOptions	array[object]	Returns the available VPAID mode options.
adSeenOnSubsequentVisitOptions	array[object]	Returns the ad seen on subsequent visit options.
adBreakTypeOptions	array[object]	Returns the available ad break type options.
breakTimingTypeOptions	array[object]	Returns the available break timing type options.
biddingTemplateOptions	array[object]	Returns the available bidding template options.
adScheduleTypeOptions	array[object]	Returns the available ad schedule type options.
distributionMethodTypeOptions	array[object]	Returns the available distribution method type options.
midrollTypeOptions	array[object]	Returns the available midroll type options.
playerTypeOptions	array[object]	Returns the available player type options.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

adManagerOptions Properties

Field Name	Type	Description
id	integer	The ID of the ad manager.
Value	string	The name of the ad manager.

vpaidModeOptions Properties

Field Name	Type	Description
id	integer	The ID of the VPAID mode option.
name	string	Name of the VPAID mode option.

adSeenOnSubsequentVisitOptions Properties

Field Name	Type	Description
id	integer	The ID of the subsequent visit option.
name	string	Name of the subsequent visit option.

adBreakTypeOptions Properties

Field Name	Type	Description
id	integer	The ID of the ad break type.
name	string	Name of the ad break type.

breakTimingTypeOptions Properties

Field Name	Type	Description
id	integer	The ID of the break timing type.
name	string	Name of the break timing type.

biddingTemplateOptions Properties

Field Name	Type	Description
name	string	The name of the bidding template.
publicId	string	The public ID of the bidding template.
mediationOptionId	integer	The ID of the mediation option.
biddingTemplateBidders	array[object]	Returns the bidders associated with the bidding template.

biddingTemplateBidders Properties

Field Name	Type	Description
id	integer	The ID of the bidding template bidder.
biddingTemplatePublicId	string	The public ID of the associated bidding template.
bidderAlias	string	The alias of the bidder.
bidderId	integer	The ID of the bidder.
name	string	The name of the bidder.
bidderLogoPath	string	The path to the bidder's logo.
bidParamValues	array[object]	Returns the bid parameter values for this bidder.

bidParamValues Properties

Field Name	Type	Description
id	integer	The ID of the bid parameter value.
biddingTemplateBidderId	integer	The ID of the associated bidding template bidder.
bidParamId	integer	The ID of the bid parameter.
value	string	The value of the bid parameter.
placeholder	string	The placeholder text for the bid parameter.

adScheduleTypeOptions Properties

Field Name	Type	Description
id	integer	The ID of the ad schedule type.
name	string	Name of the ad schedule type.
value	string	Value of the ad schedule type.
description	string	Description of the ad schedule type.

distributionMethodTypeOptions Properties

Field Name	Type	Description
id	integer	The ID of the distribution method type.
name	string	Name of the distribution method type.
value	string	Value of the distribution method type.
description	string	Description of the distribution method type.

midrollTypeOptions Properties

Field Name	Type	Description
id	integer	The ID of the midroll type.
name	string	Name of the midroll type.
value	string	Value of the midroll type.
description	string	Description of the midroll type.
icon	string	Icon identifier for the midroll type.

playerTypeOptions Properties

Field Name	Type	Description
id	integer	The ID of the player type.
name	string	Name of the player type.
value	string	Value of the player type.
description	string	Description of the player type.

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