GET Ad Schedules of Project as Select List

Overview

---

The following table contains important information about the GET method in regards to receiving ad schedules of a project as a select list.

GET Ad Schedules of Project as Select List
Method	GET
URL or Endpoint	/api/projects/projectId/ad-schedules/select-list
Headers	Authorization
Parameters	projectId, playerTypeId
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.

The description of the query parameters is as follows:

Parameter Name	Mandatory	Type	Description
playerTypeId	No	array[integer]	List of player type IDs to filter the ad schedules by.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "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	array[object]	Returns the list of ad schedules as select list items.
id	integer	The ID of the ad schedule.
name	string	Name of the ad schedule.
value	string	Value of the ad schedule.
description	string	Description of the ad schedule.
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