Skip to main content
POST
Error

Path Parameters

spacecraftId
string
required

Parent spacecraft id

Body

application/json

One payload (sensor): boresight axis + four-shape field of view (DKR-1 §3.3).

boresight
enum<string>
required

Body-frame boresight axis. One of X+, X-, Y+, Y-, Z+, Z-.

Available options:
X+,
X-,
Y+,
Y-,
Z+,
Z-
Example:

"Z+"

fovShape
enum<string>
required

Field-of-view shape primitive (CONICAL, RECTANGULAR, ELLIPTICAL, POLYGON). Determines which conditional shape parameters are required.

Available options:
CONICAL,
RECTANGULAR,
ELLIPTICAL,
POLYGON
Example:

"CONICAL"

name
string
required

Operator-supplied payload name.

Maximum string length: 100
Example:

"EO Camera"

positionX
number<double>
required

Payload mounting position X in metres (body frame; may be negative).

Example:

0.1

positionY
number<double>
required

Payload mounting position Y in metres (body frame; may be negative).

Example:

0

positionZ
number<double>
required

Payload mounting position Z in metres (body frame; may be negative).

Example:

-0.2

halfAngleDeg
number<double>

Cone half-angle in degrees (CONICAL only). Range (0°, 90°]; 90° accepted.

Required range: 0 < x < 90
Example:

30

halfHeightDeg
number<double>

FOV half-height in degrees (RECTANGULAR / ELLIPTICAL only). Range (0°, 90°) strict.

Required range: 0 < x < 90
Example:

20

halfWidthDeg
number<double>

FOV half-width in degrees (RECTANGULAR / ELLIPTICAL only). Range (0°, 90°) strict.

Required range: 0 < x < 90
Example:

10

radiusDeg
number<double>

Polygon circumscribed (to-vertices) angular radius in degrees (POLYGON only). Range (0°, 90°) strict. Datum = OUTSIDE_CONE_TOUCHING_POLYGON_AT_VERTICES (DA-3).

Required range: 0 < x < 90
Example:

30

sides
integer<int32>

Number of polygon sides (POLYGON only). 3 ≤ N ≤ 1000.

Required range: 3 <= x <= 1000
Example:

6

Response

Payload added successfully

boresight
enum<string>
Available options:
X+,
X-,
Y+,
Y-,
Z+,
Z-
fovShape
enum<string>
Available options:
CONICAL,
RECTANGULAR,
ELLIPTICAL,
POLYGON
halfAngleDeg
number<double>
halfHeightDeg
number<double>
halfWidthDeg
number<double>
id
string
name
string
payloadIndex
integer<int32>
positionX
number<double>
positionY
number<double>
positionZ
number<double>
radiusDeg
number<double>
sides
integer<int32>