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 Filters
Method	GET
URL or Endpoint	​/api​/projects​/projectId​/ad-schedules
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate
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.

The description of parameters is as follows:

Parameter Name	Type	Description
search	string	A word you want to filter.
page	integer($int32)	Page where the method makes the request.
take	integer($int32)	Number of ad schedules to take.
order	string	Indicates whether the content is ordered by ascending or descending.
insertedDate	Date	Date when inserted.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 15,
    "pageSize": 3,
    "totalCount": 44,
    "items": [
      {
        "publicId": "smyrfbut",
        "name": "AdSchedule23",
        "type": "VAST",
        "playerBidding": "",
        "dateCreated": "0001-01-01T00:00:00"
      },
      {
        "publicId": "smyrfbud",
        "name": "AdSchedule2",
        "type": "VAST",
        "playerBidding": "",
        "dateCreated": "2021-04-07T15:41:06.9633333"
      },
      {
        "publicId": "smyrfbue",
        "name": "AdSchedule2",
        "type": "VAST",
        "playerBidding": "",
        "dateCreated": "2021-04-07T16:36:48.5866667"
      }
    ]
  },
  "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.
currentPage	integer($int32)	Indicates the current page of where the ad schedule is located.
totalPages	integer($int32)	The total number of pages.
pageSize	integer($int32)	Indicates how many Ad Schedules are per page.
totalCount	integer($int32)	The total number of ad schedules received by the filter.
items	array[Object]	Returns the ad schedules on the current page as an array of objects.
publicId	string	The public ID of the ad schedule.
name	string	The name of the ad schedule.
type	string	The type of ad manager of the ad schedule.
playerBidding	string	If bidding is enabled, this field returns the id of the bidding template.
dateCreated	Date	The date when the ad schedule was created.
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