Site

PUT /udl/site/{id}

Changed on

Service operation to update a single Site. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/site/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the Site to update.

Request body

idstring

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

idEntitystring

Unique identifier of the parent entity. idEntity is required for Put.

idParentSitestring

Unique identifier of the Parent Site record associated with this Site record.

classificationMarkingstring required

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

origSiteIDstring

Unique identifier of the Site record from the originating system.

origLzIdstring

Unique identifier of the LZ record from the originating system.

pinstring

Site number of a specific electronic site or its associated equipment.

typestring

The type of this site (AIRBASE, AIRFIELD, AIRPORT, NAVAL STATION, etc.).

usagestring

The use authorization type of this site (e.g MILITARY, CIVIL, JOINT-USE, etc.).

lzUsagestring

Indicates the normal usage of the Landing Zone (LZ). Intended as, but not constrained to MIDB Helocopter Landing Area usage value definitions:

AF - Airfield

FD - Field

HC - High Crop. 1 meter and over.

HY - Highway

LB - Lake Bed

LC - Low Crop. 0-1 meters

O - Other. Explain In Remarks.

PD - Paddy

PK - Park

PS - Pasture

RB - Riverbed

SP - Sport Field

U - Unknown

Z - Inconclusive Analysis.

namestring required

The name of this site.

coordDatumstring

A mathematical model of the earth used to calculate coordinates on a map. US Forces use the World Geodetic System 1984 (WGS 84), but also use maps by allied countries with local datums. The datum must be specified to ensure accuracy of coordinates. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

coordstring

Indicates any of the magnitudes that serve to define the position of a point by reference to a fixed figure, system of lines, etc.

Pos. 1-2. Latitude Degrees [00-90]

Pos. 3-4. Latitude Minutes [00-59]

Pos. 5-6. Latitude Seconds [00-59]

Pos. 7-9. Latitude Thousandths Of Seconds [000-999]

Pos. 10. Latitude Hemisphere [NS]

Pos. 11-13. Longitude Degrees [00-180]

Pos. 14-15. Longitude Minutes [00-59]

Pos. 16-17. Longitude Seconds [00-59]

Pos. 18-20. Longitude Thousandths Of Seconds [000-999]

Pos. 21. Longitude Hemisphere [EW]

Pos. 1-21. Unknown Latitude and Unknown Longitude [000000000U000000000U].

coordDerivAccnumber double

Indicates the plus or minus error assessed against the method used to derive the coordinate.

osuffixstring

The O-suffix associated with this site. The O-suffix is a five-character alpha/numeric system used to identify a site, or demographic area, within an installation. The Installation Basic Encyclopedia (beNumber), in conjunction with the O-suffix, uniquely identifies the Site. The Installation beNumber and oSuffix are also used in conjunction with the catCode to classify the function or purpose of the facility.

iatastring

The International Air Transport Association (IATA) code of this site, if applicable.

icaostring

The International Civil Aviation Organization (ICAO) code of this site, if applicable.

faastring

The Federal Aviation Administration (FAA) Location ID of this site, if applicable.

airDefAreastring

Air Defense District (ADD) or Air Defense Area (ADA) in which the geographic coordinates reside.

utmstring

Universal Transverse Mercator (UTM) grid coordinates.

Pos. 1-2, UTM Zone Column [01-60

Pos. 3, UTM Zone Row [C-HJ-NP-X]

Pos. 4, UTM False Easting [0-9]

Pos. 5-9, UTM Meter Easting [0-9][0-9][0-9][0-9][0-9]

Pos. 10-11, UTM False Northing [0-9][0-9]

Pos. 12-16, UTM Meter Northing [0-9][0-9][0-9][0-9][0-9].

milGridSysstring

Indicates the grid system used in the development of the milGrid coordinates. Values are:

UPS - Universal Polar System

UTM - Universal Transverse Mercator.

milGridstring

The Military Grid Reference System is the geocoordinate standard used by NATO militaries for locating points on Earth. The MGRS is derived from the Universal Transverse Mercator (UTM) grid system and the Universal Polar Stereographic (UPS) grid system, but uses a different labeling convention. The MGRS is used as geocode for the entire Earth. Example of an milgrid coordinate, or grid reference, would be 4QFJ12345678, which consists of three parts:

4Q (grid zone designator, GZD)

FJ (the 100,000-meter square identifier)

12345678 (numerical location; easting is 1234 and northing is 5678, in this case specifying a location with 10 m resolution).

catCodestring

The category code that represents the associated site purpose within the target system.

catTextstring

Textual Description of Site catCode.

wacstring

World Aeronautical Chart identifier for the area in which a designated place is located.

polSubdivstring

Political subdivision in which the geographic coordinates reside. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

geoAreastring

Geographical region code used by the Requirements Management System (RMS) as specified by National Geospatial Agency (NGA) in Flight Information Publications (FIPS) 10-4, Appendix 3 - Country Code and Geographic Region Codes. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

geoidalMslSepnumber double

The distance between Mean Sea Level and a referenced ellipsoid, in meters.

allegiancestring

The DoD Standard Country Code designator for the country or political entity to which the site owes its allegiance. This field will be set to "OTHR" if the source value does not match a UDL Country code value (ISO-3166-ALPHA-2).

altAllegiancestring

Specifies an alternate allegiance code if the data provider code is not part of an official Country Code standard such as ISO-3166 or FIPS. This field will be set to the value provided by the source and should be used for all Queries specifying allegiance.

classRatingstring

Indicates the importance of the entity to the OES or MIR system. This data element is restricted to update by DIA (DB-4). Valid values are:

0 - Does not meet criteria above

1 - Primary importance to system

2 - Secondary importance to system

3 - Tertiary importance to system

O - Other. Explain in Remarks.

fpastring

Functional Production Area (FPA) under the Shared Production Program (SPP). Producers are defined per country per FPA. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

beNumberstring

The Basic Encyclopedia Number associated with the Site. Uniquely identifies the installation of a site. The beNumber is generated based on the value input for the COORD to determine the appropriate World Aeronautical Chart (WAC) location identifier, the system assigned record originator and a one-up-number.

runwaysinteger

The number of runways at the site, if applicable.

maxRunwayLengthinteger

The length of the longest runway at this site, if applicable, in meters.

conditionstring

The physical manner of being or state of existence of the entity. A physical condition that must be considered in the determining of a course of action. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

conditionAvailstring

Availability of the entity relative to its condition. Indicates the reason the entity is not fully operational. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

operStatusstring

The Degree to which an entity is ready to perform the overall operational mission(s) for which it was organized and equipped. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

gradeinteger

Indicates the amount or degree of deviation from the horizontal represented as a percent. Grade is determined by the formula: vertical distance (VD) divided by horizontal distance (HD) times 100. VD is the difference between the highest and lowest elevation within the entity. HD is the linear distance between the highest and lowest elevation.

activitystring

Indicates the function or mission of an entity, which that entity may or may not be engaged in at any particular time. Typically refers to a unit, organization, or installation/site performing a specific function or mission such as a redistribution center or naval shipyard. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

functPrimarystring

Principal operational function being performed. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

msnPrimarystring

Indicates the principal type of mission that an entity is organized and equipped to perform. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

msnPrimarySpecstring

Indicates the principal specialty type of mission that an entity is organized and equipped to perform. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

nucCapstring

A sites ability to conduct nuclear warfare. Valid Values are:

A - Nuclear Ammo Or Warheads Available

N - No Nuclear Offense

O - Other. Explain in Remarks

U - Unknown

W - Nuclear Weapons Available

Y - Nuclear Warfare Offensive Capability

Z - Inconclusive Analysis.

identstring

Estimated identity of the Site (ASSUMED FRIEND, FRIEND, HOSTILE, FAKER, JOKER, NEUTRAL, PENDING, SUSPECT, UNKNOWN):

ASSUMED FRIEND: Track assumed to be a friend due to the object characteristics, behavior, and/or origin.

FRIEND: Track object supporting friendly forces and belonging to a declared friendly nation or entity.

HOSTILE: Track object belonging to an opposing nation, party, group, or entity deemed to contribute to a threat to friendly forces or their mission due to its behavior, characteristics, nationality, or origin.

FAKER: Friendly track, object, or entity acting as an exercise hostile.

JOKER: Friendly track, object, or entity acting as an exercise suspect.

NEUTRAL: Track object whose characteristics, behavior, nationality, and/or origin indicate that it is neither supporting nor opposing friendly forces or their mission.

PENDING: Track object which has not been evaluated.

SUSPECT: Track object deemed potentially hostile due to the object characteristics, behavior, nationality, and/or origin.

UNKNOWN: Track object which has been evaluated and does not meet criteria for any standard identity.

elevMslnumber double

Ground elevation of the geographic coordinates referenced to (above or below) Mean Sea Level (MSL) vertical datum, in meters.

elevMslConfLvlinteger

Indicates the confidence level expressed as a percent that a specific geometric spatial element, ELEVATION_MSL linear accuracy, has been vertically positioned to within a specified vertical accuracy.

elevMslDerivAccnumber double

Indicates the plus or minus error assessed against the method used to derive the elevation.

vegHtnumber double

Maximum expected height of the vegetation in the Landing Zone (LZ), in meters.

vegTypestring

The predominant vegetation found in the Landing Zone (LZ). The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.

popAreaboolean

Indicates whether the facility is in or outside of a populated area. True, the facility is in or within 5 NM of a populated area. False, the facility is outside a populated area.

popAreaProxnumber double

Indicates the distance to nearest populated area (over 1,000 people) in nautical miles.

notesstring

Optional notes/comments for the site.

resProdstring

Responsible Producer - Organization that is responsible for the maintenance of the record.

evalinteger

Eval represents the Intelligence Confidence Level or the Reliability/degree of confidence that the analyst has assigned to the data within this record. The numerical range is from 1 to 9 with 1 representing the highest confidence level.

reviewDatestring date

Date on which the data in the record was last reviewed by the responsible analyst for accuracy and currency, in ISO8601 UTC format. This date cannot be greater than the current date.

recStatusstring

Validity and currency of the data in the record to be used in conjunction with the other elements in the record as defined by SOPs.

A - Active

I - Inactive

K - Acknowledged

L - Local

Q - A nominated (NOM) or Data Change Request (DCR) record

R - Production reduced by CMD decision

W - Working Record.

symCodestring

A standard scheme for symbol coding enabling the transfer, display and use of symbols and graphics among information systems, as per MIL-STD 2525B, and supported by the element ident.

referenceDocstring

The reference documentation that specifies the usage and enumerations contained in this record. If referenceDoc not provided, users may consult the data provider.

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.

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.

origNetworkstring

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.

Example request

{
  "id": "SITE-ID",
  "entity": {
    "idEntity": "ENTITY-ID",
    "name": "Example name",
    "classificationMarking": "U",
    "type": "ONORBIT",
    "idLocation": "LOCATION-ID",
    "countryCode": "US",
    "ownerType": "Commercial",
    "urls": [
      "URL1",
      "URL2"
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "location": {
      "idLocation": "LOCATION-ID",
      "classificationMarking": "U",
      "name": "Example location",
      "countryCode": "US",
      "lat": 45.23,
      "lon": 179.1,
      "altitude": 10.23,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "dataMode": "TEST",
      "origNetwork": "OPS1"
    },
    "onOrbit": {
      "idOnOrbit": "ONORBIT-ID",
      "classificationMarking": "U",
      "satNo": 1,
      "commonName": "Example common name",
      "constellation": "Big Dipper",
      "intlDes": "2021123ABC",
      "launchDate": "2018-01-01",
      "decayDate": "2018-01-01T16:00:00.123Z",
      "objectType": "PAYLOAD",
      "origin": "THIRD_PARTY_DATASOURCE",
      "missionNumber": "Expedition 1",
      "category": "Lunar",
      "lifetimeYears": 10,
      "altName": "Alternate Name",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "dataMode": "TEST",
      "launchSiteId": "LAUNCHSITE-ID",
      "countryCode": "US",
      "origNetwork": "OPS1"
    },
    "idOnOrbit": "ONORBIT-ID",
    "idOperatingUnit": "OPERATINGUNIT-ID",
    "origNetwork": "OPS1"
  },
  "idEntity": "ENTITY-ID",
  "idParentSite": "ID-Parent-Site",
  "classificationMarking": "U",
  "origSiteID": "ORIG-SITE-ID",
  "origLzId": "ORIG-LZ-ID",
  "pin": "25200",
  "type": "AIRBASE",
  "usage": "MILITARY",
  "lzUsage": "AF",
  "name": "Site Name",
  "coordDatum": "WGS",
  "coord": "340000000N0430000000E",
  "coordDerivAcc": 12.345,
  "osuffix": "BB002",
  "iata": "AAA",
  "icao": "ICA1",
  "faa": "FAA1",
  "airDefArea": "AL006",
  "utm": "19P4390691376966",
  "milGridSys": "UTM",
  "milGrid": "4QFJ12345678",
  "catCode": "20345",
  "catText": "Radar Facility, General",
  "wac": "0427",
  "polSubdiv": "IZO7",
  "geoArea": "E2",
  "geoidalMslSep": 12.34,
  "allegiance": "OTHR",
  "altAllegiance": "HL",
  "classRating": "1",
  "fpa": "EOB",
  "beNumber": "0427RT1030",
  "runways": 5,
  "maxRunwayLength": 1000,
  "condition": "RDY",
  "conditionAvail": "A",
  "operStatus": "OPR",
  "grade": 5,
  "activity": "OCC",
  "functPrimary": "JG",
  "msnPrimary": "AA",
  "msnPrimarySpec": "AB",
  "nucCap": "A",
  "ident": "FRIEND",
  "elevMsl": 123.45,
  "elevMslConfLvl": 50,
  "elevMslDerivAcc": 12.34,
  "vegHt": 3,
  "vegType": "FR",
  "popArea": true,
  "popAreaProx": 12.345,
  "notes": "Example Notes",
  "resProd": "RT",
  "eval": 7,
  "reviewDate": "2008-06-10",
  "recStatus": "A",
  "symCode": "SOGPU----------",
  "referenceDoc": "Provider Reference Documentation",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

    • info

      added the new LASEREMITTER enum value to the request property /

    • breaking

      the request property format changed from int32 to int16

    • warning

      the // request property's maxLength was set to 4

    • warning

      the // request property's min was set to 0.00

    • info

      api operation id edit_73 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.