PUT Ad Schedule Order

Overview

---

The following table contains important information about the PUT method in regards to updating the order of ad schedules.

PUT Ad Schedule Order
Method	PUT
URL or Endpoint	/api/projects/projectId/ad-schedules/order
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

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

{
  "items": [
    {
      "id": "{id}",
      "orderNumber": 0
    }
  ]
}

Information about the fields that appear when you type in the request body are displayed in the table below.

Field Name	Type	Description
items	array[object]	Array of ad schedule order items.

items Properties

Field Name	Type	Description
id	string	Unique ID of the ad schedule to be ordered.
orderNumber	integer or null	The new order number for the ad schedule.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "success": false
  },
  "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 order update result object.
success (result)	boolean	Returns true if the order was updated successfully.
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