Endpoint Examples
Create Stormtrooper Record
Registers a new Imperial Stormtrooper in the personnel database
POST
/
personnel
/
stormtroopers
Create Stormtrooper Record
curl --request POST \
--url https://api.empire.gov/v1/personnel/stormtroopers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"designation": "TK-421",
"training_facility": "Carida Academy",
"name": "Classified",
"graduation_date": "2023-12-25",
"assignment": {
"unit": "<string>",
"commanding_officer": "<string>",
"station": "<string>"
}
}
'import requests
url = "https://api.empire.gov/v1/personnel/stormtroopers"
payload = {
"designation": "TK-421",
"training_facility": "Carida Academy",
"name": "Classified",
"graduation_date": "2023-12-25",
"assignment": {
"unit": "<string>",
"commanding_officer": "<string>",
"station": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
designation: 'TK-421',
training_facility: 'Carida Academy',
name: 'Classified',
graduation_date: '2023-12-25',
assignment: {unit: '<string>', commanding_officer: '<string>', station: '<string>'}
})
};
fetch('https://api.empire.gov/v1/personnel/stormtroopers', 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/personnel/stormtroopers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'designation' => 'TK-421',
'training_facility' => 'Carida Academy',
'name' => 'Classified',
'graduation_date' => '2023-12-25',
'assignment' => [
'unit' => '<string>',
'commanding_officer' => '<string>',
'station' => '<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/personnel/stormtroopers"
payload := strings.NewReader("{\n \"designation\": \"TK-421\",\n \"training_facility\": \"Carida Academy\",\n \"name\": \"Classified\",\n \"graduation_date\": \"2023-12-25\",\n \"assignment\": {\n \"unit\": \"<string>\",\n \"commanding_officer\": \"<string>\",\n \"station\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.empire.gov/v1/personnel/stormtroopers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"designation\": \"TK-421\",\n \"training_facility\": \"Carida Academy\",\n \"name\": \"Classified\",\n \"graduation_date\": \"2023-12-25\",\n \"assignment\": {\n \"unit\": \"<string>\",\n \"commanding_officer\": \"<string>\",\n \"station\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.empire.gov/v1/personnel/stormtroopers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"designation\": \"TK-421\",\n \"training_facility\": \"Carida Academy\",\n \"name\": \"Classified\",\n \"graduation_date\": \"2023-12-25\",\n \"assignment\": {\n \"unit\": \"<string>\",\n \"commanding_officer\": \"<string>\",\n \"station\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Stormtrooper record created successfully",
"data": {
"id": "ST-7845",
"designation": "TK-421",
"training_facility": "Carida Academy",
"assignment": {
"unit": "501st Legion",
"commanding_officer": "Commander Appo",
"station": "Imperial Star Destroyer Devastator"
},
"created_at": "2023-11-07T05:31:56Z"
}
}{
"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 authorized Imperial personnel to register new Stormtrooper recruits in the Imperial database. Full functionality will be available once the API is officially deployed. Example Endpoint:POST /api/v1/personnel/stormtroopers
Placeholder Request
The following shows an example of how to create a new Stormtrooper record:{
"designation": "TK-421",
"name": "Classified",
"training_facility": "Carida Academy",
"graduation_date": "2024-03-15",
"specialization": "Standard Infantry",
"armor_size": "Medium",
"assignment": {
"unit": "501st Legion",
"commanding_officer": "Commander Appo",
"station": "Imperial Star Destroyer Devastator"
},
"clearance_level": "Standard"
}
Placeholder Response
{
"status": "success",
"message": "Stormtrooper record created successfully",
"data": {
"id": "ST-7845",
"designation": "TK-421",
"status": "active",
"created_at": "2024-06-23T10:30:00Z",
"assignment_confirmed": true
}
}
Personnel records are highly classified. This is demonstration data only.
Authorizations
Imperial Command authorisation token. Contact your commanding officer for access credentials.
Body
application/json
Stormtrooper data to register
Pattern:
^TK-[0-9]{3}$Example:
"TK-421"
Example:
"Carida Academy"
Available options:
Standard Infantry, Heavy Weapons, Scout, Commander, Specialist Birth name (classified in most records)
Example:
"Classified"
Available options:
Small, Medium, Large, Extra Large Show child attributes
Show child attributes
Available options:
Standard, Elevated, High, Top Secret ⌘I
Create Stormtrooper Record
curl --request POST \
--url https://api.empire.gov/v1/personnel/stormtroopers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"designation": "TK-421",
"training_facility": "Carida Academy",
"name": "Classified",
"graduation_date": "2023-12-25",
"assignment": {
"unit": "<string>",
"commanding_officer": "<string>",
"station": "<string>"
}
}
'import requests
url = "https://api.empire.gov/v1/personnel/stormtroopers"
payload = {
"designation": "TK-421",
"training_facility": "Carida Academy",
"name": "Classified",
"graduation_date": "2023-12-25",
"assignment": {
"unit": "<string>",
"commanding_officer": "<string>",
"station": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
designation: 'TK-421',
training_facility: 'Carida Academy',
name: 'Classified',
graduation_date: '2023-12-25',
assignment: {unit: '<string>', commanding_officer: '<string>', station: '<string>'}
})
};
fetch('https://api.empire.gov/v1/personnel/stormtroopers', 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/personnel/stormtroopers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'designation' => 'TK-421',
'training_facility' => 'Carida Academy',
'name' => 'Classified',
'graduation_date' => '2023-12-25',
'assignment' => [
'unit' => '<string>',
'commanding_officer' => '<string>',
'station' => '<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/personnel/stormtroopers"
payload := strings.NewReader("{\n \"designation\": \"TK-421\",\n \"training_facility\": \"Carida Academy\",\n \"name\": \"Classified\",\n \"graduation_date\": \"2023-12-25\",\n \"assignment\": {\n \"unit\": \"<string>\",\n \"commanding_officer\": \"<string>\",\n \"station\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.empire.gov/v1/personnel/stormtroopers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"designation\": \"TK-421\",\n \"training_facility\": \"Carida Academy\",\n \"name\": \"Classified\",\n \"graduation_date\": \"2023-12-25\",\n \"assignment\": {\n \"unit\": \"<string>\",\n \"commanding_officer\": \"<string>\",\n \"station\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.empire.gov/v1/personnel/stormtroopers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"designation\": \"TK-421\",\n \"training_facility\": \"Carida Academy\",\n \"name\": \"Classified\",\n \"graduation_date\": \"2023-12-25\",\n \"assignment\": {\n \"unit\": \"<string>\",\n \"commanding_officer\": \"<string>\",\n \"station\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Stormtrooper record created successfully",
"data": {
"id": "ST-7845",
"designation": "TK-421",
"training_facility": "Carida Academy",
"assignment": {
"unit": "501st Legion",
"commanding_officer": "Commander Appo",
"station": "Imperial Star Destroyer Devastator"
},
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": 123,
"message": "<string>",
"error_code": "ASSET_ACCESS_DENIED"
}{
"error": 123,
"message": "<string>",
"error_code": "ASSET_ACCESS_DENIED"
}
