Content for TS 24.257 Word version: 17.3.0

1… 6… 7…

7.1 General 7.2 Structure 7.3 XML schema 7.4 Data semantics 7.5 MIME types 7.6 IANA registration template

7 Coding p. 16

7.1 General p. 16

This clause specifies the coding to enable an UAE-C and an UAE-S to communicate.

7.2 Structure p. 16

The UAE document shall conform to the XML schema described in clause 7.3.

The <UAE-info> element shall be the root element of the UAE document.

The <UAE-info> element shall include at least one of the followings:

a <c2-modes-switching-configuration-info> element;
a <C2-communication-mode-notification-info> element;
a <C2-related-trigger-event-report> element;
a <C2-operation-mode-switching> element;
a <UAV-application-message-info> element;
a <C2-operation-mode-switching-performed> element;
a <registration-info> element; and
a <de-registration-info> element.

The <c2-communication-modes-configuration-info> element shall include the followings:

a <UAS-id> element;
a <C2-operation-mode-management-configuration> element which shall include the followings:
1. a <C2-operation mode-management-requirement> element;
2. an <allowed-C2-communication-modes> element;
3. a <primary-C2-communication-mode> element;
4. a <secondary-C2-communication-mode> element; and
5. a <policy-of-C2-switching> element; and
a <result> element.

The <C2-communication-mode-notification-info> element shall include the followings:

a <UAS-id> element;
a <selected-primary-C2-communication-mode> element;
a <selected-secondary-C2-communication-mode> element; and
an <acknowledgement> element.

The <C2-related-trigger-event-report> element shall include the followings:

a <UAE-client-id> element; and
an <application-QoS-related-event> element.

The <C2-operation-mode-switching> element shall include the followings:

a <UAE-server-id> element;
a <C2-operation-mode-switching-requirement> element;
a <time-validity> element; and
a <geographical-area> element.

The <UAV-application-message-info> element shall include the followings:

a <UAV-id> element;
an <application-defined-proximity-range-info> element;
an <application-payload> element; and
an <acknowledgement> element.

The <C2-operation-mode-switching-performed> element shall include the followings:

a <result> element.

The <registration-info> element shall include the followings:

a <UAV-id> element;
a <UAS-UE-information> element;
a <proposed-registration-lifetime> element;
a <registration-lifetime> element; and
a <result> element.

The <de-registration-info> element shall include the followings:

a <UAV-id> element; and
a <result> element.

7.3 XML schema p. 17

7.3.1 General p. 17

This clause defines the XML schema for application/vnd.3gpp.uae-info+xml.

7.3.2 XML schema p. 17

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:3gpp:ns:uaeInfo:1.0"
xmlns:uaeinfo="urn:3gpp:ns:uaeInfo:1.0"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
xmlns:xenc="http://www.w3.org/2001/04/xmlenc#">
  <!-- root XML element -->
  <xs:element name="uae-info" type="uaeinfo:uaeinfo-Type" id="uae"/>
  <xs:complexType name="uaeinfo-Type">
    <xs:sequence>
      <xs:element name="c2-communication-modes-configuration-info"
       type="uaeinfo:tC2CommunicationModesConfigurationType" minOccurs="0"/>
      <xs:element name="c2-communication-mode-notification-info "
       type="uaeinfo:tC2CommunicationModeNotificationType" minOccurs="0"/>
      <xs:element name="c2-related-trigger-event-report"
       type="uaeinfo:tC2RelatedTriggerEventReportType" minOccurs="0"/>
      <xs:element name="c2-operation-mode-switching"
       type="uaeinfo:tC2OperationModeSwitchingType" minOccurs="0"/>
      <xs:element name="UAV-application-message-info"
       type="uaeinfo:tUAVApplicationMessageInfoType" minOccurs="0"/>
      <xs:element name="c2-operation-mode-switching-performed"
       type="uaeinfo:tC2OperationModesSwitchingPerformedType"
       minOccurs="0"/>
      <xs:element name="registration-info"
       type="uaeinfo:tRegistrationInfoType" minOccurs="0"/>
      <xs:element name="de-registration-info"
       type="uaeinfo:tDe-registrationInfoType" minOccurs="0"/>
      <xs:any namespace="##other"
       processContents="lax"/> minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tC2CommunicationModesConfigurationType">
    <xs:sequence>
      <xs:element name="UAS-id"
       type="uaeinfo:contentType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="c2-operation-mode-management-configuration" type="uaeinfo:tC2OperationModeManagementConfigurationType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="result"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tC2CommunicationModeNotificationType">
    <xs:sequence>
      <xs:element name="UAS-id"
       type="uaeinfo:contentType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="selected-primary-C2-communication-mode"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="selected-secondary-C2-communication-mode"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="acknowlegement"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tC2RelatedTriggerEventReportType">
    <xs:sequence>
      <xs:element name="UAE-client-id"
       type="uaeinfo:contentType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="application-QoS-related-event"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tC2OperationModeSwitchingType">
    <xs:sequence>
      <xs:element name="UAE-server-id"
       type="uaeinfo:contentType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="C2-operation-mode-switching-requirement"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="time-validity"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="geographical-area-change"
       type="uaeinfo:tGeographicalAreaChange"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tUAVApplicationMessageInfoType">
    <xs:sequence>
      <xs:element name="UAV-id"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="application-defined-proximity-range-info"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="application-payload"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="acknowlegement"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tC2OperationModesSwitchingPerformedType">
    <xs:sequence>
      <xs:element name="result"
       type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tRegistrationInfoType">
    <xs:sequence>
      <xs:element name="UAV-id"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="UAS-UE-information"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="proposed-registration-lifetime"
       type="xs:integer" minOccurs="0" maxOccurs="1"/>
      <xs:element name="registration-lifetime"
       type="xs:integer" minOccurs="0" maxOccurs="1"/>
      <xs:element name="result"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tDe-registrationInfoType">
    <xs:sequence>
      <xs:element name="UAV-id"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="result"
       type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="contentType">
    <xs:choice>
      <xs:element name="uaeURI" type="xs:anyURI"/>
      <xs:element name="uaeString" type="xs:string"/>
      <xs:element name="uaeBoolean" type="xs:boolean"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:choice>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tC2OperationModeManagementConfigurationType">
    <xs:sequence>
      <xs:element name="c2-operation-mode-management-requirement" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:element name="allowed-C2-communication-modes" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:element name="primary-C2-communication-modes" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:element name="secondary-C2-communication-mode" type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="policy-of-C2-switching" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:any namespace="##other" processContents="lax"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tGeographicalAreaChange">
    <xs:sequence>
      <xs:element name="any-area-change"
       type="vaeinfo:tEmptyTypeAttribute" minOccurs="0"/>
      <xs:element name="enter-specific-area"
       type="vaeinfo:tSpecificAreaType" minOccurs="0"/>
      <xs:element name="exit-specific-area-type"
       type="vaeinfo:tSpecificAreaType" minOccurs="0"/>
      <xs:any namespace="##other" processContents="lax"
       minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="anyExt"
       type="vaeinfo:anyExtType" minOccurs="0"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tEmptyTypeAttribute">
    <xs:complexContent>
      <xs:extension base="vaeinfo:tEmptyType">
      <xs:attribute name="trigger-id"
       type="xs:string" use="required"/>
      </xs:extension>
    </xs:complexContent>
  <xs:complexType name="tSpecificAreaType">
    <xs:sequence>
      <xs:element name="geographical-area"
       type="vaeinfo:tGeographicalAreaDef"/>
      <xs:any namespace="##other" processContents="lax"
       minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="anyExt"
       type="vaeinfo:anyExtType" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="trigger-id"
       type="xs:string" use="required"/>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tGeographicalAreaDef">
    <xs:sequence>
      <xs:element name="polygon-area"
       type="vaeinfo:tPolygonAreaType" minOccurs="0"/>
      <xs:element name="ellipsoid-arc-area"
       type="vaeinfo:tEllipsoidArcType" minOccurs="0"/>
      <xs:any namespace="##other" processContents="lax"
       minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="anyExt"
       type="vaeinfo:anyExtType" minOccurs="0"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tPolygonAreaType">
    <xs:sequence>
      <xs:element name="corner"
       type="vaeinfo:tPointCoordinate" minOccurs="3" maxOccurs="15"/>
      <xs:any namespace="##other" processContents="lax"
       minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="anyExt"
       type="vaeinfo:anyExtType" minOccurs="0"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tEllipsoidArcType">
    <xs:sequence>
      <xs:element name="center" type="vaeinfo:tPointCoordinate"/>
      <xs:element name="radius" type="xs:nonNegativeInteger"/>
      <xs:element name="offset-angle" type="xs:unsignedByte"/>
      <xs:element name="included-angle" type="xs:unsignedByte"/>
      <xs:any namespace="##other" processContents="lax"
       minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="anyExt"
       type="vaeinfo:anyExtType" minOccurs="0"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
  <xs:complexType name="tPointCoordinate">
    <xs:sequence>
      <xs:element name="longitude"
       type="vaeinfo:tCoordinateType"/>
      <xs:element name="latitude"
       type="vaeinfo:tCoordinateType"/>
      <xs:any namespace="##other" processContents="lax"
       minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="anyExt"
       type="vaeinfo:anyExtType" minOccurs="0"/>
    </xs:sequence>
    <xs:anyAttribute namespace="##any" processContents="lax"/>
  </xs:complexType>
</xs:schema>

The <UAE-info> element is the root element of the XML document. The <UAE-info> element contains the <c2-communication-modes-configuration-info>, <C2-communication-mode-notification-info>, <C2-related-trigger-event-report>, <C2-operation-mode-switching>, <UAV-application-message-info>, <C2-operation-mode-switching-performed>, <registration-info> and <de-registration-info> sub-elements.

<c2-modes-switching-configuration-info> element contains the following elements:

<UAS-id>, an element contains identification of the UAS, which could be in form of identifier for the UAS, e.g. group ID, or collection of individual identifiers for the UAV and UAV-C, e.g. CAA ID, GPSI, IP address;
<C2-operation-mode-management-configuration>, an element contains the following elements:
1. <C2-operation mode-management-requirement>, an element contains the identification of the type of the C2 mode switching to be supported by the UAE server, which could be either from direct to network-assisted C2, or from network-assisted to direct C2 or to UTM navigated;
2. <allowed-C2-communication-modes>, an element contains a string set to "direct", "network assisted", or "USS/UTM navigated";
3. <primary-C2-communication-mode>, an element contains a string set to "direct", or "network assisted" used to indicate the primary C2 communication mode;
4. <secondary-C2-communication-mode>, an element contains a string set to "direct", or "network assisted" used to indicate the secondary C2 communication mode;
5. <policy-of-C2-switching>, an element contains a string set to the parameters for C2 switching, which are the QoS thresholds on active and target link, and
<result>, an element contains a string set to either "positive" or "negative" used to indicate the positive or negative result of the C2 mode switching configuration response.

<C2-communication-mode-notification-info> element contains the following elements:

<UAS-id>, an element contains identification of the UAS, which could be in form of identifier for the UAS, e.g. group ID, or individual identifiers for the UAV and UAV-C, e.g. CAA ID, GPSI, IP address;
<selected-primary-C2-communication-mode>, an element contains a string set to "direct", or "network assisted" used to indicate the selected primary C2 communication mode;
<selected-secondary-C2-communication-mode>, an element contains a string set to "direct", or "network assisted" used to indicate the selected secondary C2 communication mode; and
<acknowledgement>, an element contains a string set to either "yes" or "not" used to indicate the acknowledgement of selected C2 communication mode(s).

<C2-related-trigger-event-report> element contains the following elements:

<UAE-client-id>, an element contains a string set to the identifier of the UAE client which indicates the QoS downgrade; and
<application-QoS-related-event>, an element contains a string indicating the expected or actual application QoS/QoE parameters which were changed (i.e. latency, throughput, reliability, jitter).

<C2-operation-mode-switching> element contains the following elements:

<UAE-server-id>, an element contains a string set to the identifier of the UAE server which instructs the UAS to apply the C2 mode switching;
<C2-operation-mode-switching-requirement>, an element contains a string set to either "direct to network-assisted" or "network-assisted to direct" used to indicate the type of the C2 mode switching to be applied;
<time-validity>, an element contains a string set to the time validity for the C2 switching requirement; and
<geographical-area>, an element specifying a geographical area for which the C2 switching applies and has the following sub-elements:
1. <polygon-area>, an optional element specifying the area as a polygon specified in clause 5.4 of TS 23.032; and
2. <ellipsoid-arc-area>, an optional element specifying the area as an ellipsoid arc specified in clause 5.7 of TS 23.032.

<UAV-application-message-info> element contains the following elements:

<UAV-id>, an element contains the unique identifier of a UAV which requests the sending of the UAV application message. The UAV-id is in the form of a 3GPP UE ID (e.g. GPSI, External Identifier) or CAA level UAV ID as assigned by civil aviation authorities (e.g. FAA) via USS/UTM;
<application-defined-proximity-range-info>, an element contains the range information over which the UAV application message is to be sent;
<application-payload>, an element contains the application payload that is to be delivered to the other UAVs; and
<acknowledgement>, an element contains a string set to either "yes" or "not" used to indicate the acknowledgement of communications between UAVs within a geographical area.

<C2-operation-mode-switching-performed> element contains the following elements:

<result>, an element contains a string set to either "positive" or "negative" used to indicate the positive or negative result of the reception.

<registration-info> element contains the following elements:

<UAV-id>, an element contains the unique identifier of a UAV which initiates the UAS UE registration procedure;
<UAS-UE-information>, an element contains the information (e.g. UAS UE IP address) the UAS UE needs to provide to the UAE-S;
<proposed-registration-lifetime>, an element contains the time during which the UAS UE wants to stay registered to the UAE-S for receiving UAV application messages from the UAS application specific server;
<registration-lifetime>, an element contains the time during which the UAS UE can stay registered to the UAE-S for receiving UAV application messages from the UAS application specific server; and
<result>, an element contains a string set to either "success" or "failure" indicating success or failure of the UAS UE registration.

<de-registration-info> element contains the following elements:

<UAV-id>, an element contains the unique identifier of a UAV which initiates the UAS UE de-registration procedure; and
<result>, an element contains a string set to either "success" or "failure" indicating success or failure of the UAS UE de-registration.

7.5 MIME types p. 22

The MIME type for the UAE document shall be "application/vnd.3gpp.uae-info+xml MIME body".

7.6 IANA registration template p. 22

Your Email Address:

Media Type Name:

Application

Subtype name:

application/vnd.3gpp.uae-info+xml

Required parameters:

None

Optional parameters:

"charset"

the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in Section 9.1 of RFC 7303.

Encoding considerations:

binary.

Security considerations:

Same as general security considerations for application/xml media type as specified in Section 9.1 of RFC 7303. In addition, this media type provides a format for exchanging information in SIP or in HTTP, so the security considerations from IETF RFC 3261 apply while exchanging information in SIP and the security considerations from IETF RFC 7231 apply while exchanging information in HTTP.

The information transported in this media type does not include active or executable content.

Mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in TS 24.229.

This media type does not include provisions for directives that institute actions on a recipient's files or other resources.

This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way.

This media type does not employ compression.

Interoperability considerations:

Same as general interoperability considerations for application/xml media type as specified in Section 9.1 of RFC 7303. Any unknown XML elements and any unknown XML attributes are to be ignored by recipient of the MIME body.

Published specification:

3GPP TS 24.257 "Uncrewed Aerial System (UAS) Application Enabler (UAE) layer; Protocol aspects; Stage 3" version 17.0.0, available via http://www.3gpp.org/specs/numbering.htm.

Applications which use this media type:

Applications supporting the Uncrewed Aerial System (UAS) Application Enabler (UAE) layer as described in the published specification.

Fragment identifier considerations:

The handling in Section 5 of RFC 7303 applies.

Restrictions on usage:

None

Provisional registration? (standards tree only):

N/A

Additional information:

Deprecated alias names for this type: none
Magic number(s): none
File extension(s): none
Macintosh File Type Code(s): none
Object Identifier(s) or OID(s): none

Intended usage:

Common

Person to contact for further information:

Name: <MCC name>
Email: <MCC email address>
Author/Change controller:
1. Author: 3GPP CT1 Working Group/3GPP_TSG_CT_WG1@LIST.ETSI.ORG
2. Change controller: <MCC name>/<MCC email address>