Signaling Protocols and Procedures for Citizens Broadband Radio Service (CBRS)
Extensions to Spectrum Access System (SAS) - SAS Interface Technical Specification (Release 2)
Document WINNF-TS-3003
Version V1.3.0
6 June 2023
This document has been prepared by the CBRS Committee Work Group 3 to assist The Software Defined Radio Forum Inc. (or its successors or assigns, hereafter "the Forum"). It may be amended or withdrawn at a later time and it is not binding on any member of the Forum or of the CBRS Committee Work Group 3.
Contributors to this document that have submitted copyrighted materials (the Submission) to the Forum for use in this document retain copyright ownership of their original work, while at the same time granting the Forum a non-exclusive, irrevocable, worldwide, perpetual, royalty-free license under the Submitter's copyrights in the Submission to reproduce, distribute, publish, display, perform, and create derivative works of the Submission based on that original work for the purpose of developing this document under the Forum's own copyright.
Permission is granted to the Forum's participants to copy any portion of this document for legitimate purposes of the Forum. Copying for monetary gain or for other non-Forum related purposes is prohibited.
THIS DOCUMENT IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NON-INFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE FORUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS DOCUMENT.
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.
This document was developed following the Forum's policy on restricted or controlled information (Policy 009) to ensure that that the document can be shared openly with other member organizations around the world. Additional Information on this policy can be found here: http://www.wirelessinnovation.org/page/Policies\_and\_Procedures.
Although this document contains no restricted or controlled information, the specific implementation of concepts contain herein may be controlled under the laws of the country of origin for that implementation. Readers are encouraged, therefore, to consult with a cognizant authority prior to any further development.
Wireless Innovation Forum ™ and SDR Forum ™ are trademarks of the Software Defined Radio Forum Inc.
The following individuals made significant contributions to this document:
Group Chair: Sho Furuichi (Sony), Amit Mukhopadhyay (Nokia)
Editor: Sho Furuichi (Sony)
Other Member Representatives:
This document is a Technical Specification that extends the SAS-SAS interface [n.1] to support Release 2 features and procedures. Some features, data objects and parameters defined in [n.1] are deprecated in the Release 2 SAS-SAS interface, including
The key words "required", "shall", "shall not", "should", "should not", "recommended", "may", and "optional" in this document are to be interpreted as described in RFC 2119 [n.2]. In addition, the key word "conditional" shall be interpreted to mean that the definition is an absolute requirement of this specification only if the stated condition is met.
The following referenced documents are necessary for the application of the present document.
In addition to definitions in [n.3], the following definitions are also used in this document.
Feature ID: A string identifying the name of a Release 2 feature. Feature IDs applicable to this specification are WInnForum-defined Feature IDs included in this document or third-party proprietary Feature IDs.
Non-Regulatory Impacting Feature Capability List: A list of Feature IDs representing all operationally supported features of a SAS that do not impact Part 96 regulatory compliance.
Regulatory Impacting Feature Capability List: A list of Feature IDs representing all operationally supported features of a SAS that could impact Part 96 regulatory compliance.
In addition to abbreviations specified in [n.3], the following abbreviations are also used in this document.
FID Feature ID
This section defines feature capability exchange procedure which ensures backward and forward compatibility between operations between different releases of SASs. Section 4.1.1 provides backward and forward compatibility principles of inter-release operation. Section 4.1.2 describes how a SAS should treat feature-specific parameters received from a peer SAS. Feature
Capability Exchange shall facilitate the exchange of both WInnForum defined Feature IDs and proprietary Feature IDs. WInnForum defined Feature IDs (starting with "WF_") are specified in this document starting with section 4.2. Third party proprietary Feature IDs shall be prefixed with CBRS vendor/administrator IDs registered in WINNF-SSC-0013 [n.15].
To allow predictable operation between SASs supporting different releases of SAS-SAS protocols, the SAS-SAS protocol in this specification is designed to be backward and forward compatible. To ensure backward compatibility, any SAS beyond Release 1 shall exchange the Non-Regulatory Impacting Feature Capability List and the Regulatory Impacting Feature Capability List in the synchronization process as described in Section 5. A feature operationally supported by a SAS shall be included in the Non-Regulatory Impacting Feature Capability List if the SAS uses the feature in a way that does not impact Part 96 regulatory compliance. A feature operationally supported by a SAS shall be included in the Regulatory Impacting Feature Capability List if the SAS uses the feature in a way that could impact Part 96 regulatory compliance.
A SAS shall ignore unrecognized feature names in the Feature Capability Lists and unrecognized parameters associated with features it doesn't support received from a peer SAS. If a SAS does not receive the Feature Capability Lists from a peer SAS, the peer SAS shall be treated as a Release 1 SAS.
Feature specific parameters are always Conditional or Optional and are identified with the corresponding feature names. A SAS shall ignore a parameter received from a peer SAS if the parameter name is unrecognized or the SAS does not support the feature associated with the parameter.
This feature supports CBSD grouping information exchange using the SAS-CBSD and the SAS-SAS interfaces. This feature does not impact Part 96 regulatory compliance.
This feature does not define how to use CBSD grouping information but only allows the exchange of grouping information. Depending on specific grouping information, it may be necessary for a SAS to share the information with peer SASs through the SAS-SAS interface. By using this feature, a SAS may optionally share the CBSD grouping information with peer SASs by including the GroupParam object and/or the GroupConfig object in the CbsdData Object, as defined in Table 4.
When generating the CBSD Data Record of a CBSD that contains GroupParam and GroupConfig objects, a SAS may prefix the value of groupId parameter with its SAS Administrator ID (i.e., $ADMINISTRATOR_ID) and/or a user ID to make sure groupId is globally unique among all Groups (managed by all SASs) having same groupType.
This feature enables the use of enhanced antenna patterns (EAP) to allow more efficient use of the CBRS spectrum in accordance with requirements and applicable use cases provided in Annex 5 of WINNF-TS-1001 [n.18]. This feature can be used as non-regulatory impacting and/or regulatory impacting depending on use cases.
A SAS operationally supporting this feature shall include antennaVerticalBeamwidth and/or antennaModel and/or frontToBackRatio, as defined in WINNF-TS-3002 [n.17], in installationParam in Table 5 if antennaVerticalBeamwidth and/or antennaModel and/or frontToBackRatio are available for a CBSD. A SAS operationally supporting this feature shall perform operations according to requirements defined in the Annex 5 of WINNF-TS-1001 [n.18].
This feature allows the CBSD to indicate to the SAS whether it is a CPE-CBSD by setting the cpeCbsdIndication parameter in the CBSD Registration Procedure or in the Feature Capability Exchange Procedure [n.17]. This feature does not impact Part 96 regulatory compliance.
A SAS operationally supporting this feature shall include cpeCbsdIndication in Table 4 if cpeCbsdIndication is available for the CBSD.
This feature enables a SAS to include identities of PAL Holders in the Zone Data Records of the associated PPAs, where FCC Registration Number (FRN) is used as identities of PAL Holders. Use cases of this feature can be found in [n.18].
At a period specified in [n.4], the SAS shall generate a Full Activity Dump comprised of activity dump files corresponding to the SAS Feature Capability Record, qualifying CBSD Data Records, Zone Data Records, and ESC Sensor Records. A SAS shall provide information on accessing activity dump files through the URL in Table 1.
In particular, records in Full Activity Dump shall include:
The dump data itself shall also be made available for at least 14 days.
Release 2 compliant SASs shall always include the SAS Feature Capability Record in Full Activity Dump data. If Full Activity Dump data retrieved from a peer SAS does not include the SAS Feature Capability Record, the peer SAS shall be considered a Release 1 SAS.
SAS-SAS Records shall be encoded using JSON (JavaScript Object Notation) as defined in RFC-7159 [n.5].
The HTTP GET method shall be used for all SAS-SAS requests. The URL endpoints for SAS-SAS requests are described in Table 1. A SAS administrator may choose to use the same or different $BASE_URL in Table 1 for transporting records defined in different releases of SAS-SAS protocols. A SAS administrator shall ensure that all operational URLs are able to properly receive and respond to requests from peer SASs supporting different releases of SAS-SAS protocols pursuant to the backward and forward compatibility principles described in section 4.1.1.
Table 1: SAS Record Types and URL constructions
| SAS Record Type | sas_record_type | URL construction |
|---|---|---|
| SAS Feature Capability | sas_feature | Not applicable |
| CBSD Data | cbsd | Not applicable |
| ESC Sensor Data | esc_sensor | Not applicable |
| Zone Data | zone | Not applicable |
| Coordination events | coordination | Not applicable |
| Full Activity Dump | dump | HTTP request: GET $BASE_URL/dump Return type: FullActivityDump object (See 7.6) |
In this section, parameters of SAS-SAS records are described in more detail. A parameter value can be one of the primitive JSON data types (string, number, boolean, array, or object). If a parameter is an object, a name for the object is given and a separate table describes parameters in the object.
Each parameter is indicated as "Required", "Optional" or "Conditional". The definitions of these indicators are as follows:
"Required": The parameter shall always be included in the object it belongs to.
"Optional": The parameter may be included in the object it belongs to.
"Conditional": The parameter shall be included in the object it belong to, if and only if the specified conditions are satisfied.
The tables of parameters in this section have a column marked R/O/C that indicates whether the particular parameter is "Required", "Optional", or "Conditional".
The JSON objects specified in the following subsections are conformant with RFC-4627 [n.14]. Note that this means that Unicode characters are used and have a default encoding of UTF-8.
Feature-specific parameters shall be described with the following column format:
Table 2: Column Format for Release 2 Parameters
Parameter
NAME: [Name of extension parameter]
DATA TYPE: [One of JSON Data Types specified in section 7]
FEATURE ID: [Feature ID(s) or Mandatory]
The label "FEATURE ID" describes in which specific features this parameter is used. The values are WInnForum defined FIDs or "Mandatory", where "Mandatory" means that the parameter does not depend on specific-features and shall be supported for Release 2 operation.
Any parameter which does not have the "FEATURE ID" label is specified in WINNF-TS-0096 [n.1] and its description is reproduced here for information only.
Table 3: SasFeatureCapability Object Definition
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: id DATA TYPE: string FEATURE ID: Mandatory | Required | • Format: sas_feature/$ADMINISTRATOR_ID $ADMINISTRATOR_ID is a unique SAS administrator identifier. |
NAME: nonRegFeatureCapabilityList DATA TYPE: array of string FEATURE ID: Mandatory | Required | This parameter represents SAS's Non- Regulatory Impacting Feature Capability List which may contain zero or more FIDs. |
NAME: regFeatureCapabilityList DATA TYPE: array of string FEATURE ID: Mandatory | Required | This parameter represents SAS’s Regulatory Impacting Feature Capability List which may contain zero or more FIDs. |
This section defines CbsdData Object for Release 2 CBSDs. See details in WINNF-TS-0016 [n.9] for creation of Release 1 CBSD Data Record.
Table 4: CbsdData Object Definition
| Table 4: CbsdData Object Definition | ||
|---|---|---|
| Parameter | R/O/C | Parameter Information |
NAME: id DATA TYPE: string | Required | Format: cbsd/$CBSD_REFERENCE_ID $CBSD_REFERENCE_ID is defined as $FCC_ID + "/" + sha1($SERIAL_NUMBER). $FCC_ID and $SERIAL_NUMBER are the unescaped fccId and cbsdSerialNumber strings of the CBSD registered during the CBSD Registration Procedure [n.9]. SHA-1 is applied to the unescaped cbsdSerialNumber string with no additional line termination characters. |
NAME: registration DATA TYPE: object: RegistrationInformation | Required | This parameter contains the registration information of the CBSD associated with the id parameter. |
NAME: grants DATA TYPE: array of object: GrantData | Required | An array of one or more data object that contains the information of Grants of the CBSD associated with the id parameter. |
NAME: groupingParam DATA TYPE: array of object: GroupParam FEATURE ID: WF_ENHANCED_GROUP_HANDLING | Optional | An array of data objects that contains the information about the Group(s) currently associated with that CBSD. See details of GroupParam object definition in WINNF-TS-3002 [n.17]. |
NAME: groupingConfig DATA TYPE: array of object: GroupConfig FEATURE ID: WF_ENHANCED_GROUP_HANDLING | Optional | An array of data objects that includes information concerning group configuration currently associated with the CBSD. See details of GroupConfig object definition in WINNF-TS-3002 [n.17]. |
NAME: cpeCbsdIndication DATA TYPE: boolean FEATURE ID: WF_CPE_CBSD_INDICATOR | Conditional | This parameter, when set to TRUE, indicates the CBSD is a CPE-CBSD. The value FALSE indicates the CBSD is not a CPE-CBSD. This parameter shall be included if its value is available for a CBSD. |
NAME: eapCalculationMethod DATA TYPE: string EXTENSION TYPE: RELEASE 2 FEATURE ID: WF_ENH_ANTENNA_PATTERN | Optional | A character that specifies the CBSD antenna gain calculation method (A, B, C, D, E or F). If this parameter does not return any value above, the SAS shall consider the calculation method as the default method F. |
Table 5: RegistrationInformation Object Definition
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: userId DATA TYPE: string | Optional | This parameter contains a User Registration ID (UR-ID) of the CBSD that was registered to the SAS Implementation. |
NAME: fccId DATA TYPE: string | Required | This parameter contains a FCC ID of the CBSD that was registered to the SAS Implementation. |
NAME: cbsdSerialNumber DATA TYPE: string | Optional | This parameter contains a serial number of the CBSD that was registered to the SAS Implementation. |
NAME: callSign DATA TYPE: string | Optional | This parameter contains a call sign of the CBSD User of the CBSD that was registered to the SAS Implementation. |
NAME: cbsdCategory DATA TYPE: string | Required | This parameter contains the category of the CBSD that was registered to the SAS Implementation. |
NAME: cbsdInfo DATA TYPE: object: CbsdInfo | Optional | A data object that contains CBSD model information that was registered to the SAS Implementation. See details of CbsdInfo object definition in WINNF-TS-3002 [n.17]. |
NAME: installationParam DATA TYPE: object: InstallationParam | Required | A data object that contains all the installation parameters of the CBSD that were registered to the SAS Implementation. All of the parameters, specified in the InstallationParam object, that were registered to the SAS Implementation shall be included in this object. See details of InstallationParam object definition in WINNF-TS-3002 [n.17]. |
NAME: airInterface DATA TYPE: object: AirInterface | Required | A data object that contains air interface information of the CBSD that were registered to the SAS Implementation. All of the parameters, specified in the AirInterface object, that were registered to the SAS Implementation shall be included in this object. See details of AirInterface object definition in WINNF-TS-3002 [n.17]. |
NAME: measCapability DATA TYPE: array of string | Required | This parameter contains the measurement capability of the CBSD that were registered to the SAS Implementation. |
Table 6: GrantData Object Definition
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: id DATA TYPE: string | Required | A Grant identifier unique to this Grant and CBSD allowing peer SASs to identify the Grant. |
NAME: operationParam DATA TYPE: object: OperationParam | Required | This data object includes operation parameters associated with the approved Grant. See details of OperationParam object definition in WINNF-TS-3002 [n.17]. |
NAME: requestedOperationParam DATA TYPE: object: OperationParam | Required | This data object includes operation parameters that were requested for the Grant by the CBSD during the CBSD Grant Procedure. See details of OperationParam object definition in WINNF-TS-3002 [n.17]. |
NAME: channelType DATA TYPE: string | Required | Channel type of the Grant. The acceptable values are: • "PAL": the channel is a PAL channel. • "GAA": the frequency range is for GAA use. |
NAME: grantExpireTime DATA TYPE: string | Required | Indicates the UTC time when the Grant expires. Format: YYYY-MM-DDThh:mm:ssZ [n.8] |
Table 7: EscSensorData Object Definition
| Table 7: EscSensorData Object Definition | ||
|---|---|---|
| Parameter | R/O/C | Parameter Information |
NAME: id DATA TYPE: string | Required | Format: esc_sensor/$ADMINISTRATOR_ID/$SENSOR_ID $ADMINISTRATOR_ID is the a unique SAS Administrator identifier. $SENSOR_ID is a unique identifier for the referenced ESC Sensor created by the ESC Operator. |
NAME: installationParam DATA TYPE: object: EscInstallationParam | Required | Contains ESC Sensor installation parameters |
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: protectionLevel DATA TYPE: number | Optional | The protection level to be applied to this ESC Sensor in units of dBm/MHz. If not present, the default value of the protection level specified in [n.7] shall be applied to the ESC Sensor associated with the id parameter. |
| Table 8: EscInstallationParam object | ||
|---|---|---|
| Parameter | R/O/C | Parameter Information |
NAME: latitude DATA TYPE: number | Required | Latitude of the ESC antenna location in degrees relative to the WGS 84 datum [n.12]. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. Values are specified using 6 digits to the right of the decimal point. |
NAME: longitude DATA TYPE: number | Required | Longitude of the ESC antenna location in degrees relative to the WGS84 datum [n.12]. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. Values are specified using 6 digits to the right of the decimal point. |
NAME: height DATA TYPE: number | Required | This parameter contains the ESC antenna height in meters that may be expressed as an integer or as a numeric value including a decimal point. When the heightType parameter value is "AGL", the antenna height should be given relative to ground level. When the heightType parameter value is "AMSL", it is given with respect to WGS84 datum. |
NAME: heightType DATA TYPE: string | Required | The value should be "AGL" or "AMSL". AGL height is measured relative to the ground level. AMSL height is measured relative to the mean sea level. |
NAME: antennaAzimuth DATA TYPE: number | Required | This parameter contains the boresight direction of the horizontal plane of the ESC antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. |
NAME: antennaDowntilt DATA TYPE: number | Required | If present, this parameter contains the ESC antenna down tilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). |
NAME: azimuthRadiationPattern DATA TYPE: array of object: RadiationPattern | Required | This parameter specifies an ESC antenna radiation pattern or an effective ESC antenna radiation pattern in any direction in the azimuthal plane, specified at 1 degree increments referenced to the antenna boresight direction. |
NAME: elevationRadiationPattern DATA TYPE: array of object: RadiationPattern | Required | If present, this parameter specifies an ESC antenna radiation pattern or an effective ESC antenna radiation pattern in any direction in the elevation plane (orthogonal to the azimuthal plane). |
Table 9: RadiationPattern object
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: angle DATA TYPE: number | Required | This is the radiation angle. In the azimuth plane: the value is given in degrees relative to the antenna boresight direction. The value of this parameter is an integer, increasing in the clockwise direction as viewed from above, between 0 and 359 inclusive. In the elevation plane: the angle is given in degrees relative to the horizon. The value of this parameter is an integer between -180 and 180 inclusive. Radiation below the horizon has a positive elevation angle and radiation above the horizon has a negative elevation angle. |
NAME: gain DATA TYPE: number | Required | The radiation gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi). The gain provided is the gain in the direction of 'angle'. |
Table 10: ZoneData Object Definition
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: id DATA TYPE: string | Required | Format: zone/$CREATOR/$ZONE_ID When the usage parameter is equal to "PPA", the format of the $CREATOR string is "ppa/$ADMINISTRATOR_ID" and the $ZONE_ID is equal to the PPA-ID string. When the usage parameter is equal to "CENSUS_TRACT" the format of the $CREATOR string is "census_tract/census/$YEAR" and the $ZONE_ID is equal to the FIPS code of the census tract. $YEAR is equal to the census year in which the census tract was defined. Note: this zone type exchange is optional. When the usage parameter is equal to "EXCLUSION_ZONE” the format of the $CREATOR string is "exclusion_zone/ntia/$DATE", and $DATE is a "YYYY_MM_DD" string describing the date on which NTIA issued the definition of the exclusion zone. $ZONE_ID is a unique reference identifier of an exclusion zone. |
NAME: name DATA TYPE: string | Optional | Human-readable local significant string. The name of this zone. |
| Parameter | R/O/C | Parameter Information |
NAME: creator DATA TYPE: string | Optional | This parameter contains the creator of the Zone Data associated with the $ZONE_ID. The value of this parameter shall be used as $CREATOR in the id parameter. The value of $CREATOR shall be ppa/$ADMINISTRATOR_ID if the value of the usage parameter is “PPA”. The value of $CREATOR shall be exclusion_zone/ntia/$DATE if the value of the usage parameter is "EXCLUSION_ZONE”, where $DATE is expressed by using the format, YYYY_MM_DD, describing the date on which NTIA issued the definition of the exclusion zone. The value of $CREATOR shall be census_tract/census/$YEAR if the value of the usage parameter is "CENSUS_TRACT", where $YEAR is equal to the census year in which the census tract was defined. |
NAME: usage DATA TYPE: string | Required | This parameter describes the usage (i.e. type of zone) of the zone data. One of the following shall be included: • CENSUS_TRACT • PPA • EXCLUSION_ZONE |
NAME: ppaInfo DATA TYPE: object: PPAInformation | Conditional | if the usage parameter is equal to "PPA", this parameter shall be included. |
NAME: zone DATA TYPE: object: GeoJSON | Required | Self-contained geometry description of the addressed zone data [n.10]. See details in Normative Annex B of WINNE-TS-0096 [n.1] |
Table 11: PPAInformation Object Definition
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: palId DATA TYPE: array of string | Required | List of one or more PAL Database Record IDs (ref: [n.11]) upon which the PPA is based. All PALs indicated in this parameter shall have a single PAL Holder. |
NAME: cbsdReferenceId DATA TYPE: array of string | Required | List of one or more CBSD Reference IDs in the cluster list of the PPA. The format of CBSD Reference ID shall follow the definition of id parameter in CbsdData object. |
NAME: ppaBeginDate DATA TYPE: string | Required | Date of the start of the PPA protection period. Format: YYYY-MM-DDThh:mm:ssZ [n.5] |
NAME: ppaExpirationDate DATA TYPE: string | Required | This field represents the PPA expiration date. Format: YYYY-MM-DDThh:mm:ssZ [n.5] |
NAME: ppaRegionType DATA TYPE: string | Required | This field describes the region type of the PPA to be used in calculating the path loss for PPA protection. The field shall be set to one of the following values: · "URBAN" · "SUBURBAN" · "RURAL" |
NAME: frn DATA TYPE: string FEATURE ID: WF_EXTENSION_PPA_INFO | Conditional | The FCC Registration Number (FRN) of the PAL Holder who owns the PPA. This parameter is equivalent to the parameter "frn" in [n. 11] for original PAL licensees, or the FRN of lessees or other entities authorized to use the PAL license. This field shall be included if the SAS operationally supports Extension to PPA Information feature. |
Table 12: CoordinationEvent object
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: id DATA TYPE: string | Required | Format: coordination/$ADMINISTRATOR_ID/$EVENT_ID $ADMINISTRATOR_ID is a SAS Administrator ID. $EVENT_ID is Coordination Event record ID created by the originating SAS Administrator. |
NAME: name DATA TYPE: string | Optional | Human-readable local unique reference to the Coordination Event Record. |
NAME: creator DATA TYPE: string | Optional | Human-readable string identifying the creator of the Coordination Event Record. |
NAME: creationDate DATA TYPE: string | Required | This parameter is the date the Coordination Event Record was created. Format: YYYY-MM-DDThh:mm:ssZ[n.8] |
NAME: expirationDate DATA TYPE: string | Required | This parameter is the expiration date of the Coordination Event Record. Format: YYYY-MM-DDThh:mm:ssZ[n.8] |
NAME: description DATA TYPE: string | Optional | Human-readable description of the Coordination Event Record. |
NAME: coordinationType DATA TYPE: string | Required | This parameter is the type of the Coordination Event Record. One of the following values shall be included: INTERFERENCE_REPORT AD_HOC_EXCLUSION_ZONE ENFORCEMENT_ACTION ESC_SENSOR_DEPLOYMENT |
NAME: coordinationDevice DATA TYPE: array of string | Conditional | This parameter contains one or more IDs of the device involved in the Coordination Event Record. Acceptable values of the element of this parameter is as follows: The value of the id parameter of the CbsdData object The value of the id parameter of the EscSensorData object Identifier of a specific incumbent device This parameter shall be included if the coordinationType parameter is set to "ESC_SENSOR_DEPLOYMENT" or "INTERFERENCE_REPORT". |
NAME: coordinationZone DATA TYPE: array of string | Conditional | This parameter contains one or more IDs of the Zone Data involved in the Coordination Event Record. This parameter shall be included if the coordinationType parameter is set to "AD_HOC_EXCLUSION_ZONE”. |
NAME: coordinationData DATA TYPE: object: CoordinationData | Optional | This parameter is an object that contains the event-specific data. |
Table 13: CoordinationData Object Definition
| Parameter | R/O/C | Parameter Information |
|---|---|---|
| The contents of this object are FFS. |
Table 14: FullActivityDump object
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: files DATA TYPE: array of object: ActivityDumpFile | Required | Array of one or more objects corresponding to files comprising the Full Activity Dump data. |
NAME: generationDateTime DATA TYPE: string | Required | The date and time at which the Full Activity Dump data was generated. Format: YYYY-MM-DDThh:mm:ssZ [n.8] |
NAME: description DATA TYPE: string | Optional | Any additional human-readable description the source SAS may wish to attach. |
Table 15: ActivityDumpFile object
| Parameter | R/O/C | Parameter Information |
|---|---|---|
NAME: url DATA TYPE: string | Required | The retrieval URLs at which the peer SAS can retrieve the activity dump file. Retrieval of the resources at these URLs shall support byte-range requests using the HTTP Content-Range mechanisms [n.13]. |
NAME: checksum DATA TYPE: string | Required | The SHA-1 checksum of the contents of the activity dump file referred to by url. |
NAME: size DATA TYPE: number | Required | The size of the activity dump file in bytes. |
NAME: version DATA TYPE: string | Required | The version of the SAS-SAS protocol used for generating this file. The value of this string shall be “v2.0”. |
NAME: recordType DATA TYPE: string | Required | The type of records contained in the activity dump file The value of this parameter shall be one of the sas_record_type values as defined in Table 1. Examples: "sas_feature”, “zone", "cbsd", "coordination" |
The activity dump file retrieved from the url field specified in the ActivityDumpFile object is composed of a MessageAggregation Object as defined in Table 16.
Table 16: MessageAggregation Object Definition
| Parameter | R/O/C | Parameter information |
|---|---|---|
NAME: recordData DATA TYPE: array of object | Required | An array of zero or more SAS record(s) with the same record type, as specified in recordType of the corresponding ActivityDumpFile object. |
| Document history | ||
|---|---|---|
| V1.0.0 | 2 April 2020 | Initial version balloted and approved for publication |
| V1.1.0 | 30 September 2020 | Technical revision addressing numerous change requests |
| V1.2.0 | 20 December 2021 | Technical Revision adding the new feature “Extension to PPA Information” |
| V1.3.0 | 6 June 2023 | Implemented: • WINNF-23-I-00017-r1 CR - EAP Feature SAS-SAS • Minor editorial changes |
Pages