Decommission Imperial Asset

Removes an Imperial asset from active service records

DELETE /assets/{asset_id}

Decommission Imperial Asset

cURL

curl --request DELETE \
  --url https://api.empire.gov/v1/assets/{asset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "authorized_by": "<string>"
}
'

import requests

url = "https://api.empire.gov/v1/assets/{asset_id}"

payload = {
    "reason": "<string>",
    "authorized_by": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', authorized_by: '<string>'})
};

fetch('https://api.empire.gov/v1/assets/{asset_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.empire.gov/v1/assets/{asset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'authorized_by' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.empire.gov/v1/assets/{asset_id}"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"authorized_by\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.empire.gov/v1/assets/{asset_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"authorized_by\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.empire.gov/v1/assets/{asset_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"authorized_by\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "message": "Asset decommissioned successfully",
  "data": {
    "asset_id": "TIE-7742",
    "asset_type": "TIE Fighter",
    "former_pilot": "TK-421",
    "decommission_reason": "Combat damage - beyond repair",
    "decommissioned_at": "2023-11-07T05:31:56Z",
    "authorized_by": "Commander Vader"
  }
}

{
  "error": 123,
  "message": "<string>",
  "error_code": "ASSET_ACCESS_DENIED"
}

{
  "error": 123,
  "message": "<string>",
  "error_code": "ASSET_ACCESS_DENIED"
}

This endpoint is currently in development. The example below shows placeholder functionality for demonstration purposes.

Endpoint Overview

This endpoint will allow high-ranking Imperial officers to decommission assets from Imperial records. This could include decommissioning vehicles, equipment, or facilities. Full functionality will be available once the API is officially deployed.

Example Endpoint: DELETE /api/v1/assets/{asset_id}

Placeholder Request

Remove an Imperial asset from active records:

Path Parameters:

• asset_id (string): The unique identifier of the asset to decommission

Example: DELETE /api/v1/assets/TIE-7742

Placeholder Response

{
  "status": "success",
  "message": "Asset decommissioned successfully",
  "data": {
    "asset_id": "TIE-7742",
    "asset_type": "TIE Fighter",
    "former_pilot": "TK-421",
    "decommission_reason": "Combat damage - beyond repair",
    "decommissioned_at": "2024-06-23T14:45:00Z",
    "authorized_by": "Commander Vader"
  }
}

Error Response

{
  "status": "error",
  "message": "Asset not found or insufficient clearance",
  "error_code": "ASSET_ACCESS_DENIED"
}

Asset decommissioning requires Level 7 Imperial clearance or higher. Unauthorized attempts will be logged.

Authorizations

Authorization · string · header · required

Imperial Command authorisation token. Contact your commanding officer for access credentials.

Path Parameters

asset_id · string · required

Unique identifier of the asset to decommission

Pattern: ^[A-Z]{3}-[0-9]{4}$

Example:

"TIE-7742"

Body

application/json

Decommission details

reason · string · required

Reason for decommissioning

authorized_by · string · required

Imperial officer authorizing the decommission

Response

200

application/json

Asset decommissioned successfully

status · string

Example:

"success"

message · string

Example:

"Asset decommissioned successfully"

data · object

Show child attributes