BLbluestaq
RF

GET /udl/rfband

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/rfband
  • Auth
    none declared

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

idEntitystring required

Unique identifier of the parent Entity which uses this band.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

namestring required

RF Band name.

bandstring

Name of the band of this RF range (e.g. X,K,Ku,Ka,L,S,C,UHF,VHF,EHF,SHF,UNK,VLF,HF,E,Q,V,W). See RFBandType for more details and descriptions of each band name.

mode'TX' | 'RX'

RF Band mode (e.g. TX, RX).

purpose'COMM' | 'TTC' | 'OPS' | 'OTHER'

Purpose or use of the RF Band -- COMM = communications, TTC = Telemetry/Tracking/Control, OPS = Operations, OTHER = Other.

freqMinnumber double

Start/minimum of transmit RF frequency range, if applicable, in megahertz.

freqMaxnumber double

End/maximum of transmit RF frequency range, if applicable, in megahertz.

centerFreqnumber double

Center frequency of RF frequency range, if applicable, in megahertz.

peakGainnumber double

RF Range maximum gain, in decibel relative to isotrope.

edgeGainnumber double

RF Range edge gain, in decibel relative to isotrope.

bandwidthnumber double

RF Band frequency range bandwidth in megahertz.

beamwidthnumber double

Angle between the half-power (-3 dB) points of the main lobe of the antenna, in degrees.

polarization'H' | 'V' | 'R' | 'L'

Transponder polarization e.g. H - (Horizontally Polarized) Perpendicular to Earth's surface, V - (Vertically Polarized) Parallel to Earth's surface, L - (Left Hand Circularly Polarized) Rotating left relative to the Earth's surface, R - (Right Hand Circularly Polarized) Rotating right relative to the Earth's surface.

erpnumber double

Effective Radiated Power (ERP) is the total power in decibel watts radiated by an actual antenna relative to a half-wave dipole rather than a theoretical isotropic antenna. A half-wave dipole has a gain of 2.15 dB compared to an isotropic antenna. EIRP(dB) = ERP (dB)+2.15 dB or EIRP (W) = 1.64*ERP(W). Effective radiated power and effective isotropic radiated power both measure the amount of power a radio transmitter and antenna (or other source of electromagnetic waves) radiates in a specific direction: in the direction of maximum signal strength (the main lobe) of its radiation pattern.

eirpnumber double

EIRP is defined as the RMS power input in decibel watts required to a lossless half-wave dipole antenna to give the same maximum power density far from the antenna as the actual transmitter. It is equal to the power input to the transmitter's antenna multiplied by the antenna gain relative to a half-wave dipole. Effective radiated power and effective isotropic radiated power both measure the amount of power a radio transmitter and antenna (or other source of electromagnetic waves) radiates in a specific direction: in the direction of maximum signal strength (the main lobe) of its radiation pattern.

frequencySettingsnumber[]

Array of frequency settings, in megahertz for this RFBand. This array and the settings arrays must match in size.

gainSettingsnumber[]

Array of gain settings, in decibels for this RFBand. If this array is specified then it must be the same size as the frequencySettings array. A null value may be used for one or more of the frequencies in the frequencySettings array if there is no corresponding value for a given frequency.

delaySettingsnumber[]

Array of delay settings, in seconds for this RFBand. If this array is specified then it must be the same size as the frequencySettings array. A null value may be used for one or more of the frequencies in the frequencySettings array if there is no corresponding value for a given frequency.

bandwidthSettingsnumber[]

Array of frequency range bandwidth settings, in megahertz for this RFBand. If this array is specified then it must be the same size as the frequencySettings array. A null value may be used for one or more of the frequencies in the frequencySettings array if there is no corresponding value for a given frequency.

beamwidthSettingsnumber[]

Array of beamwidth settings, in degrees for this RFBand. If this array is specified then it must be the same size as the frequencySettings array. A null value may be used for one or more of the frequencies in the frequencySettings array if there is no corresponding value for a given frequency.

noiseSettingsnumber[]

Array of signal noise settings, in decibels for this RFBand. If this array is specified then it must be the same size as the frequencySettings array. A null value may be used for one or more of the frequencies in the frequencySettings array if there is no corresponding value for a given frequency.

sourcestring required

Source of the data.

originstring

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.

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.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "id": "ad88770b-d824-443f-bdce-5f9e3fa500a9",
    "idEntity": "ENTITY-ID",
    "classificationMarking": "U",
    "name": "BAND_NAME",
    "band": "Ku",
    "mode": "TX",
    "purpose": "TTC",
    "freqMin": 50.23,
    "freqMax": 2000.23,
    "centerFreq": 1000.23,
    "peakGain": 120.23,
    "edgeGain": 100.23,
    "bandwidth": 100.23,
    "beamwidth": 45.23,
    "polarization": "H",
    "erp": 2.23,
    "eirp": 2.23,
    "frequencySettings": [
      12250.1,
      15000.1
    ],
    "gainSettings": [
      2.77,
      5.64
    ],
    "delaySettings": [
      2.77,
      5.64
    ],
    "bandwidthSettings": [
      250.1,
      500.1
    ],
    "beamwidthSettings": [
      5.1,
      10.1
    ],
    "noiseSettings": [
      0.00033,
      0.0033
    ],
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "createdAt": "2025-03-05T16:00:00.123Z",
    "createdBy": "some.user",
    "origNetwork": "OPS1"
  }
]

Changes

  • 45631f9bb3f0Revision changes
    • info

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.