GET Ad Schedules by Filter

Overview

---

The following table contains important information about the GET method in regards to receiving the ad schedules by filters.

GET Ad Schedules by Filter
Method	GET
URL or Endpoint	/api/projects/projectId/ad-schedules
Headers	Authorization
Parameters	projectId, search, page, take, order, insertDate
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	Type	Description
search	string	A search term to filter ad schedules by.
order	string	Indicates whether the results are ordered by ascending or descending. Default is "asc".
insertDate	string($date-time)	Filter by the date when the ad schedule was inserted.
page	integer	The page number to retrieve. Default is 1.
take	integer	Number of ad schedules per page. Default is 10.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 0,
    "totalPages": 0,
    "pageSize": 0,
    "totalCount": 0,
    "items": [
      {
        "publicId": "{publicId}",
        "name": "{name}",
        "type": "{type}",
        "playerBidding": "{playerBidding}",
        "playerType": "{playerType}",
        "dateCreated": "2024-05-28T11:44:17.062Z",
        "orderNumber": 0
      }
    ]
  },
  "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 paginated response object.
currentPage	integer	Indicates the current page.
totalPages	integer	The total number of pages.
pageSize	integer	Indicates how many ad schedules are per page.
totalCount	integer	The total number of ad schedules matching the filter.
items	array[object]	Returns the ad schedules on the current page.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

items Properties

Field Name	Type	Description
publicId	string	The public ID of the ad schedule.
name	string	The name of the ad schedule.
type	string	The type of the ad schedule.
playerBidding	string	The bidding template associated with the ad schedule.
playerType	string	The type of the player assigned to the ad schedule.
dateCreated	string($date-time)	The date when the ad schedule was created.
orderNumber	integer or null	The order number of the ad schedule.

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