--- title: "GET /udl/soiobservationset" method: GET path: "/udl/soiobservationset" tags: ["Observation"] --- # GET /udl/soiobservationset `GET /udl/soiobservationset` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/soiobservationset` - Auth: none declared Service operation to dynamically query data by a variety of query parameters. The query will return the SOI Observation Sets and not the associated SOI Observations. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `startTime` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - SOIObservationSetAbridged[] - `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. - `msgCreateDate` string, date-time: SOI msgCreateDate time in ISO 8601 UTC time, with millisecond precision. - `idSensor` string: ID of the observing sensor. - `origSensorId` string: Optional identifier provided by the record source to indicate the sensor identifier to which this attitude set applies if this set is reporting a single sensor orientation. This may be an internal identifier and not necessarily a valid sensor ID. - `sensorAsId` string: ID of the AttitudeSet record for the observing sensor. - `idOnOrbit` string: Unique identifier of the target on-orbit object, if correlated. - `satNo` integer: Satellite/catalog number of the target on-orbit object. - `origObjectId` string: Optional identifier provided by observation source to indicate the target onorbit object of this observation. This may be an internal identifier and not necessarily a valid satellite number. - `senlat` number, double: Sensor WGS84 latitude at startTime (if mobile/onorbit) in degrees. If null, can be obtained from sensor info. -90 to 90 degrees (negative values south of equator). - `senlon` number, double: Sensor WGS84 longitude at startTime (if mobile/onorbit) in degrees. If null, can be obtained from sensor info. -180 to 180 degrees (negative values south of equator). - `senalt` number, double: Sensor altitude at startTime (if mobile/onorbit) in kilometers. - `senx` number, double: Cartesian X position of the observing mobile/onorbit sensor at startTime, in kilometers, in the specified senReferenceFrame. If senReferenceFrame is null then J2K should be assumed. - `seny` number, double: Cartesian Y position of the observing mobile/onorbit sensor at startTime, in kilometers, in the specified senReferenceFrame. If senReferenceFrame is null then J2K should be assumed. - `senz` number, double: Cartesian Z position of the observing mobile/onorbit sensor at startTime, in kilometers, in the specified senReferenceFrame. If senReferenceFrame is null then J2K should be assumed. - `senvelx` number, double: Cartesian X velocity of the observing mobile/onorbit sensor at startTime, in kilometers per second, in the specified senReferenceFrame. If senReferenceFrame is null then J2K should be assumed. - `senvely` number, double: Cartesian Y velocity of the observing mobile/onorbit sensor at startTime, in kilometers per second, in the specified senReferenceFrame. If senReferenceFrame is null then J2K should be assumed. - `senvelz` number, double: Cartesian Z velocity of the observing mobile/onorbit sensor at startTime, in kilometers per second, in the specified senReferenceFrame. If senReferenceFrame is null then J2K should be assumed. - `idElset` string: ID of the UDL Elset of the Space Object under observation. - `startTime` string, date-time, required: Observation set detection start time in ISO 8601 UTC with microsecond precision. - `endTime` string, date-time: Observation set detection end time in ISO 8601 UTC with microsecond precision. - `numObs` integer, required: The number of observation records in the set. - `type` 'OPTICAL' | 'RADAR', required: Observation type (OPTICAL, RADAR). - `polarAngleStart` number, double: Polar angle of the gimbal/mount at observation set detection start time in degrees. - `polarAngleEnd` number, double: Polar angle of the gimbal/mount at observation set detection end time in degrees. - `referenceFrame` 'J2000' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'ITRF' | 'GCRF': The reference frame of the observation measurements. If the referenceFrame is null it is assumed to be J2000. - `senReferenceFrame` 'J2000' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'ITRF' | 'GCRF': The reference frame of the observing sensor state. If the senReferenceFrame is null it is assumed to be J2000. - `losDeclinationStart` number, double: Line of sight declination at observation set detection start time. Specified in degrees, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed (e.g -30 to 130.0). - `losDeclinationEnd` number, double: Line of sight declination at observation set detection end time. Specified in degrees, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed (e.g -30 to 130.0). - `pointingAngleAzStart` number, double: Pointing angle of the Azimuth gimbal/mount at observation set detection start time. Specified in degrees. - `pointingAngleAzEnd` number, double: Pointing angle of the Azimuth gimbal/mount at observation set detection end time. Specified in degrees. - `pointingAngleElStart` number, double: Pointing angle of the Elevation gimbal/mount at observation set detection start time. Specified in degrees. - `pointingAngleElEnd` number, double: Pointing angle of the Elevation gimbal/mount at observation set detection end time. Specified in degrees. - `pixelArrayWidth` integer: Pixel array size (width) in pixels. - `pixelArrayHeight` integer: Pixel array size (height) in pixels. - `numSpectralFilters` integer: The value is the number of spectral filters used. - `spectralFilters` string[]: Array of the SpectralFilters keywords, must be present for all values n=1 to numSpectralFilters, in incrementing order of n, and for no other values of n. - `collectionMode` string: Mode indicating telescope movement during collection (AUTOTRACK, MANUAL AUTOTRACK, MANUAL RATE TRACK, MANUAL SIDEREAL, SIDEREAL, RATE TRACK). - `gain` number, double: The gain used during the collection, in units of photoelectrons per analog-to-digital unit (e-/ADU). If no gain is used, the value = 1. - `binningHoriz` integer: The number of pixels binned horizontally. - `binningVert` integer: The number of pixels binned vertically. - `solarMag` number, double: The in-band solar magnitude at 1 A.U. - `pixelMin` integer: The minimum valid pixel value. - `pixelMax` integer: The maximum valid pixel value. - `softwareVersion` string: Software Version used to Capture, Process, and Deliver the data. - `satelliteName` string: Name of the target satellite. - `starCatName` string: Name of the Star Catalog used for photometry and astrometry. - `corrQuality` number, double: Object Correlation Quality value. Measures how close the observed object's orbit is to matching an object in the catalog. The scale of this field may vary depending on provider. Users should consult the data provider to verify the meaning of the value (e.g. A value of 0.0 indicates a high/strong correlation, while a value closer to 1.0 indicates low/weak correlation). - `uct` boolean: Boolean indicating whether the target object was unable to be correlated to a known object. This flag should only be set to true by data providers after an attempt to correlate to an OnOrbit object was made and failed. If unable to correlate, the 'origObjectId' field may be populated with an internal data provider specific identifier. - `validCalibrations` string: Key to indicate which, if any of, the pre/post photometer calibrations are valid for use when generating data for the EOSSA file. If the field is not populated, then the provided calibration data will be used when generating the EOSSA file (e.g. PRE, POST, BOTH, NONE). - `calibrationType` string: Type of calibration used by the Sensor (e.g. ALL SKY, DIFFERENTIAL, DEFAULT, NONE). - `percentSatThreshold` number, double: A threshold for percent of pixels that make up object signal that are beyond the saturation point for the sensor that are removed in the EOSSA file, in range of 0 to 1. - `changeDetected` boolean: Boolean indicating if any change event was detected, based on historical collection data for the object. - `periodicityChangeDetected` boolean: Boolean indicating if a periodicity change event was detected, based on historical collection data for the object. - `brightnessVarianceChangeDetected` boolean: Boolean indicating if a brightness variance change event was detected, based on historical collection data for the object. - `solarPhaseAngleBrightnessChangeDetected` boolean: Boolean indicating if a solar phase angle brightness change event was detected, based on historical collection data for the object. - `changeConf` string: Overall qualitative confidence assessment of change detection results (e.g. HIGH, MEDIUM, LOW). - `collectionDensityConf` string: Qualitative Collection Density assessment, with respect to confidence of detecting a change event (e.g. HIGH, MEDIUM, LOW). - `periodicitySamplingConf` string: Qualitative Periodicity Sampling assessment, with respect to confidence of detecting a change event (e.g. HIGH, MEDIUM, LOW). - `periodicityDetectionConf` string: Qualitative assessment of the periodicity detection results from the Attitude and Shape Retrieval (ASR) Periodicity Assessment (PA) Tool (e.g. HIGH, MEDIUM, LOW). - `collectionId` string: Universally Unique collection ID. Mechanism to correlate Single Point Photometry (SPP) JSON files to images. - `calibrations` SOICalibrationAbridged[]: Array of SOI Calibrations associated with this SOIObservationSet. - `calExtinctionCoeff` number, double: Coefficient value for how much signal would be lost to atmospheric attenuation for a star at zenith, in magnitudes per air mass. - `calSkyBg` number, double: Average Sky Background signals in magnitudes, at calibration. Sky Background refers to the incoming light from an apparently empty part of the night sky. - `calBgIntensity` number, double: Background intensity, at calibration, specified in kilowatts per steradian per micrometer. - `calSpectralFilterSolarMag` number, double: In-band solar magnitudes at 1 A.U, at calibration (e.g. -5.0 to 30.0). - `calZeroPoint` number, double: Value representing the difference between the catalog magnitude and instrumental magnitude for a set of standard stars, at calibration (e.g. -5.0 to 30.0). - `calNumDetectedStars` integer: Number of detected stars in the FOV with the target object, at calibration. Helps identify frames with clouds. - `calNumCorrelatedStars` integer: Number of correlated stars in the FOV with the target object, at calibration. Can be 0 for narrow FOV sensors. - `calExtinctionCoeffUnc` number, double: Extinction coefficient uncertainty in magnitudes, at calibration, which represents the difference between the measured brightness and predicted brightness of the star with the extinction removed, making it exo-atmospheric (e.g. -5.0 to 30.0). - `calExtinctionCoeffMaxUnc` number, double: Maximum extinction coefficient uncertainty in magnitudes, at calibration (e.g. -5.0 to 30.0). - `calTime` string, date-time: Start time of calibration in ISO 8601 UTC time, with millisecond precision. - `calType` string: Type of calibration (e.g. PRE, MID, POST). - `tags` string[]: Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team. - `transactionId` string: Optional identifier to track a commercial or marketplace transaction executed to produce this data. - `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. - `sourceDL` string: The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL. - `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. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 2 info - api operation id `findAll_98` 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/soiobservationset/get.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)