Skip to main content

PUT Ad Schedule Order

Overview


The table below provides key details about the PUT method for updating the order of ad schedules.

PUT Ad Schedule Order
MethodPUT
URL or Endpoint/api/projectId/ad-schedules/order
HeadersAuthorization
ParametersprojectId
BodyCheck the request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

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

Information about the fields that appear on body request are displayed in the table below.

Field NameTypeDescription
itemsarray[Object]Array that contain objects
idstringUnique ID for the ad schedule to be ordered
orderNumberintegerOrder number of the ad schedule

Response

{
"success": true,
"errors": [],
"messages": [],
"result": true,
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultboolReturn a boolean value based on the result of the response.
resultInfostringReturns extra information about the result.
statusCodeintegerReturns 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