Skip to main content

POST - Reorder graphic plans

Reorder graphic plans

Request​

  • Method: POST
  • Endpoint: /locations/{id}/graphic-plans/reorder
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: reorder-graphic-plans

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Request Body​

Required: no Content-Type: application/json Schema: LocationGraphicPlanRequest

Schema
{
  "$ref": "#/components/schemas/LocationGraphicPlanRequest"
}

Example: example-1​

{
  "graphicPlanIds": [
    "12a8af51-52f6-409b-82c2-08bbd5df18c2",
    "78691588-9adf-457b-ad56-3426e6d8e3d9"
  ]
}

Responses​

200 OK​

Content-Type: application/json Schema: LocationGraphicPlanResponse

Schema
{
  "$ref": "#/components/schemas/LocationGraphicPlanResponse"
}

400 Bad Request​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "nvalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "collection elements non-unique",
      "code": "input.data.invalid",
      "identifier": "requests"
    }
  ]
}

401 Unauthorized​

404 Not Found​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

406 Not Acceptable​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "mismatch in the types of content",
  "code": "not.acceptable",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

500 Internal Server Error​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}