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": {
    "": [
      {
        "id": 0,
        "Value": "string"
      }
    ],
    "vpaidModeOptions": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "adSeenOnSubsequentVisitOptions": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "adBreakTypeOptions": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "breakTimingTypeOptions": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "biddingTemplateOptions": [
      {
        "name": "string",
        "publicId": "string",
        "mediationOptionId": 0,
        "biddingTemplateBidders": [
          {
            "id": 0,
            "biddingTemplatePublicId": "string",
            "bidderAlias": "string",
            "bidderId": 0,
            "name": "string",
            "bidderLogoPath": "string",
            "bidParamValues": [
              {
                "id": 0,
                "biddingTemplateBidderId": 0,
                "bidParamId": 0,
                "value": "string",
                "placeholder": "string"
              }
            ]
          }
        ]
      }
    ],
    "adScheduleTypeOptions": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "description": "string"
      }
    ],
    "distributionMethodTypeOptions": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "description": "string"
      }
    ],
    "midrollTypeOptions": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "description": "string",
        "icon": "string"
      }
    ]
  },
  "resultInfo": "string",
  "statusCode": 0
}

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.
adManagerOptions	Object	Returns the ad manager option.
id	integer	The 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	The 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	The ID of the subsequent visit option.
name	string	Name of the subsequent visit option.
adBreakTypeOptions	array[Object]	Returns the ad break type options.
id	integer	The 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	The 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	The ID of the mediation option.
biddingTemplateBidders	array[Object]	Returns the template bidders as an array of objects.
adScheduleTypeOptions	array[Object]	Returns the ad schedule type options.
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	array[Object]	Returns the distribution method type options.
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	array[Object]	Returns the midroll type options.
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.
resultInfo	string	Returns extra information about the result.
statusCode	integer	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