---
title: "POST /udl/seradataopticalpayload"
method: POST
path: "/udl/seradataopticalpayload"
tags: ["Sensor"]
---

# POST /udl/seradataopticalpayload

`POST /udl/seradataopticalpayload`

## Request

- Base URL: `https://unifieddatalibrary.com`
- URL: `https://unifieddatalibrary.com/udl/seradataopticalpayload`
- Auth: none declared

Service operation to take a single SeradataOpticalPayload as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

## Request body

- SeradataOpticalPayloadIngest: Details for an optical payload from Seradata.
  - `id` string: Unique identifier of the record, auto-generated by the system.
  - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
  - `spacecraftId` string, required: Seradata ID of the spacecraft (SeradataSpacecraftDetails ID).
  - `idSensor` string: UUID of the Sensor record.
  - `hostedForCompanyOrgId` string: Hosted for company/Organization Id.
  - `manufacturerOrgId` string: Manufacturer Organization Id.
  - `imagingPayloadCategory` string: Imaging category for this payload, e.g. Multispectral, Infrared, Panchromatic.
  - `name` string: Sensor name from Seradata, e.g. TOURNESOL, MESSR (Multispectral Self-Scanning Radiometer), AWFI, etc.
  - `spectralBand` string: Spectral Band supported by this payload, e.g. Green, Red, Mid-wave infrared, etc.
  - `spectralFrequencyLimits` string: Frequency limit for this payload, e.g. 0.51 - 0.59.
  - `numberOfFilmReturnCanisters` integer: Number of film return canisters.
  - `bestResolution` number, double: Best resolution.
  - `swathWidth` number, double: Swath width in kilometers.
  - `recorderSize` string: Recorder size.
  - `fieldOfView` number, double: Field of view of this radar in kilometers.
  - `fieldOfRegard` number, double: Field of regard of this radar in degrees.
  - `pointingMethod` string: Point method for this radar, e.g. Spacecraft.
  - `groundStations` string: Ground Station info for this payload.
  - `groundStationLocations` string: Ground Station Locations for this payload.
  - `notes` string: Payload notes.
  - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
  - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
  - `source` string, required: Source of the data.
  - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.
  - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.
  - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

## Response `201`

Success

## Other responses

- `400`: Bad Request
- `401`: Invalid/Missing User Credentials
- `403`: User Is Not Authorized
- `405`: Method Not Allowed
- `415`: MediaType Unsupported
- `429`: Rate of Requests Exceeds Allowed Limit
- `500`: Internal Server Error

## Changes

> 12 revisions in range; 1 could not be searched.

- **2025-04-16** `75f764c843a9`: 1 breaking, 2 info
  - the `numberOfFilmReturnCanisters` request property format changed from `int32` to `int16`
  - api operation id `create_109` removed and replaced with ``
  - the endpoint scheme security `BasicAuth` was removed from the API

[Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/seradataopticalpayload/post.md)

---

[API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)