Delete Location - Plugixa Car Rental for WordPress

Delete Location - Plugixa Car Rental

DELETE /plugixa-car-rental/v1/locations/{id}

Move a location to the trash.

The user needs the plugixa_car_rental_delete capability.

A location cannot be trashed while a car is based there, or while an upcoming or current booking is picked up or returned there. Give those cars another home location and cancel or move those bookings first.

A trashed location can be brought back, or deleted for good: see the trash.

Request

DELETE https://your-site.example/wp-json/plugixa-car-rental/v1/locations/1

Path parameters

Name	Type	Description
`id`	`integer`	The location’s id

Responses

`200` OK. The location is in the trash.

{
  "success": true,
  "data": {
    "trashed": true
  }
}

Field	Type	Meaning
`data.trashed`	`boolean`	Always `true`

Errors

Status	Code	When
`404`	`plugixa_car_rental_not_found`	No location with that id, or it is in the trash.
`409`	`plugixa_car_rental_in_use`	Cars are based here, or upcoming bookings use it. `data.blockers` lists each reason as a sentence.

Plus the errors every endpoint can return.

Examples

curl -s -X DELETE "https://your-site.example/wp-json/plugixa-car-rental/v1/locations/1" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/v1/locations/1');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-car-rental/v1/locations/1', {
  method: 'DELETE',
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data } = await response.json();