PAWS: getSpectrum

Requests information about the available spectrum for a device at a location. Requests from a fixed-mode device must include owner information so the device can be registered with the database.

In the request, the device provides information about itself, including its regulatory details, location, antenna height and (if required by the regulatory authority) ownership information. With this input, the database determines the available spectrum for the device and reports it back in the response along with additional details required by PAWS.

Request

HTTP request

POST https://www.googleapis.com/rpc

Request body

In the request body, supply data with the following structure:

{
  "jsonrpc": "2.0",
  "method": "spectrum.paws.getSpectrum",
  "apiVersion": "v1explorer",
  "id": string,
  "params": {
    "key": api key,
    "type": "AVAIL_SPECTRUM_REQ",
    "version": "1.0",
    "deviceDesc": {
      "serialNumber": string,
      "manufacturerId": string,
      "modelId": string,
      "rulesetIds": [
        string
      ],
      "fccId": string,
      "fccTvbdDeviceType": string,
      "etsiEnDeviceType": string,
      "etsiEnDeviceEmissionsClass": string,
      "etsiEnTechnologyId": string,
      "etsiEnDeviceCategory": string
    },
    "location": {
      "point": {
        "center": {
          "latitude": double,
          "longitude": double
        },
        "semiMajorAxis": double,
        "semiMinorAxis": double,
        "orientation": double
      },
      "region": {
        "exterior": [
          {
            "latitude": double,
            "longitude": double
          }
        ]
      },
      "confidence": integer
    },
    "antenna": {
      "height": double,
      "heightType": string,
      "heightUncertainty": double
    },
    "owner": {
      "owner": {
        "fn": string,
        "org": {
          "text": string
        },
        "adr": {
          "pobox": string,
          "street": string,
          "locality": string,
          "region": string,
          "code": string,
          "country": string
        },
        "tel": {
          "uri": string
        },
        "email": {
          "text": string
        }
      },
      "operator": {
        "fn": string,
        "org": {
          "text": string
        },
        "adr": {
          "pobox": string,
          "street": string,
          "locality": string,
          "region": string,
          "code": string,
          "country": string
        },
        "tel": {
          "uri": string
        },
        "email": {
          "text": string
        }
      }
    },
    "capabilities": {
      "frequencyRanges": [
        {
          "startHz": double,
          "stopHz": double,
          "maxPowerDBm": double,
          "channelId": string
        }
      ]
    },
    "masterDeviceDesc": {
      "serialNumber": string,
      "manufacturerId": string,
      "modelId": string,
      "rulesetIds": [
        string
      ],
      "fccId": string,
      "fccTvbdDeviceType": string,
      "etsiEnDeviceType": string,
      "etsiEnDeviceEmissionsClass": string,
      "etsiEnTechnologyId": string,
       "etsiEnDeviceCategory": string
    },
    "requestType": string
  }
}
Property name Value Description Notes
type string The message type: AVAIL_SPECTRUM_REQ.

Required field
version string The PAWS version. Must be exactly 1.0.

Required field.
deviceDesc nested object When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for that device is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.
deviceDesc.serialNumber string The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
deviceDesc.manufacturerId string The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
deviceDesc.modelId string The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
deviceDesc.rulesetIds[] list The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.

For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
deviceDesc.fccId string Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
deviceDesc.fccTvbdDeviceType string Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
deviceDesc.etsiEnDeviceType string Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnDeviceEmissionsClass string Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnTechnologyId string Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnDeviceCategory string Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
location nested object The geolocation of the master device (a device with geolocation capability that makes an available spectrum request) is required whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability). The location must be the location of the radiation center of the master device's antenna. To support mobile devices, a regulatory domain may allow the anticipated position of the master device to be given instead. If the location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error code if it does not support query by region.
location.point nested object If present, indicates that the geolocation represents a point. Paradoxically, a point is parameterized using an ellipse, where the center represents the location of the point and the distances along the major and minor axes represent the uncertainty. The uncertainty values may be required, depending on the regulatory domain.
location.point.center nested object A required geo-spatial point representing the center of the ellipse.
location.point.center.latitude double A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.point.center.longitude double A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.point.semiMajorAxis double A floating-point number that expresses the location uncertainty along the major axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
location.point.semiMinorAxis double A floating-point number that expresses the location uncertainty along the minor axis of the ellipse. May be required by the regulatory domain. When the uncertainty is optional, the default value is 0.
location.point.orientation double A floating-point number that expresses the orientation of the ellipse, representing the rotation, in degrees, of the semi-major axis from North towards the East. For example, when the uncertainty is greatest along the North-South direction, orientation is 0 degrees; conversely, if the uncertainty is greatest along the East-West direction, orientation is 90 degrees. When orientation is not present, the orientation is assumed to be 0.
location.region nested object If present, indicates that the geolocation represents a region. Database support for regions is optional.
location.region.exterior[] list When the geolocation describes a region, the exterior field refers to a list of latitude/longitude points that represent the vertices of a polygon. The first and last points must be the same. Thus, a minimum of four points is required. The following polygon restrictions from RFC5491 apply:
  • A connecting line shall not cross another connecting line of the same polygon.
  • The vertices must be defined in a counterclockwise order.
  • The edges of a polygon are defined by the shortest path between two points in space (not a geodesic curve). Consequently, the length between two adjacent vertices should be restricted to a maximum of 130 km.
  • All vertices are assumed to be at the same altitude.
  • Polygon shapes should be restricted to a maximum of 15 vertices (16 points that include the repeated vertex).
location.region.exterior[].latitude double A required floating-point number that expresses the latitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.region.exterior[].longitude double A required floating-point number that expresses the longitude in degrees using the WGS84 datum. For details on this encoding, see the National Imagery and Mapping Agency's Technical Report TR8350.2.
location.confidence integer The location confidence level, as an integer percentage, may be required, depending on the regulatory domain. When the parameter is optional and not provided, its value is assumed to be 95. Valid values range from 0 to 99, since, in practice, 100-percent confidence is not achievable. The confidence value is meaningful only when geolocation refers to a point with uncertainty.
antenna nested object Depending on device type and regulatory domain, the characteristics of the antenna may be required.
antenna.height double The antenna height in meters. Whether the antenna height is required depends on the device type and the regulatory domain. Note that the height may be negative.
antenna.heightType string If the height is required, then the height type (AGL for above ground level or AMSL for above mean sea level) is also required. The default is AGL.
antenna.heightUncertainty double The height uncertainty in meters. Whether this is required depends on the regulatory domain.
owner nested object Depending on device type and regulatory domain, device owner information may be included in an available spectrum request. This allows the device to register and get spectrum-availability information in a single request.
owner.owner nested object The vCard contact information for the individual or business that owns the device is required.
owner.owner.fn string The full name of the contact person. For example: John A. Smith.
owner.owner.org nested object The organization associated with the registering entity.
owner.owner.org.text string The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
owner.owner.adr nested object The street address of the entity.
owner.owner.adr.pobox string An optional post office box number.
owner.owner.adr.street string The street number and name. For example: 123 Any St.
owner.owner.adr.locality string The city or local equivalent portion of the address. For example: San Jose.
owner.owner.adr.region string The state or local equivalent portion of the address. For example: CA.
owner.owner.adr.code string The postal code associated with the address. For example: 94423.
owner.owner.adr.country string The country name. For example: US.
owner.owner.tel nested object A telephone number that can be used to call the contact.
owner.owner.tel.uri string A nested telephone URI of the form: tel:+1-123-456-7890.
owner.owner.email nested object An email address that can be used to reach the contact.
owner.owner.email.text string The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
owner.operator nested object The vCard contact information for the device operator is optional, but may be required by specific regulatory domains.
owner.operator.fn string The full name of the contact person. For example: John A. Smith.
owner.operator.org nested object The organization associated with the registering entity.
owner.operator.org.text string The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
owner.operator.adr nested object The street address of the entity.
owner.operator.adr.pobox string An optional post office box number.
owner.operator.adr.street string The street number and name. For example: 123 Any St.
owner.operator.adr.locality string The city or local equivalent portion of the address. For example: San Jose.
owner.operator.adr.region string The state or local equivalent portion of the address. For example: CA.
owner.operator.adr.code string The postal code associated with the address. For example: 94423.
owner.operator.adr.country string The country name. For example: US.
owner.operator.tel nested object A telephone number that can be used to call the contact.
owner.operator.tel.uri string A nested telephone URI of the form: tel:+1-123-456-7890.
owner.operator.email nested object An email address that can be used to reach the contact.
owner.operator.email.text string The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith@example.com.
capabilities nested object The master device may include its device capabilities to limit the available-spectrum response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.
capabilities.frequencyRanges[] list An optional list of frequency ranges supported by the device. Each element must contain start and stop frequencies in which the device can operate. Channel identifiers are optional. When specified, the database should not return available spectrum that falls outside these ranges or channel IDs.
capabilities.frequencyRanges[].startHz double The required inclusive start of the frequency range (in Hertz).
capabilities.frequencyRanges[].stopHz double The required exclusive end of the frequency range (in Hertz).
capabilities.frequencyRanges[].maxPowerDBm double The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
capabilities.frequencyRanges[].channelId string The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
masterDeviceDesc nested object When an available spectrum request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device, which is provided in a separate parameter).
masterDeviceDesc.serialNumber string The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
masterDeviceDesc.manufacturerId string The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
masterDeviceDesc.modelId string The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
masterDeviceDesc.rulesetIds[] list The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.

For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
masterDeviceDesc.fccId string Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
masterDeviceDesc.fccTvbdDeviceType string Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
masterDeviceDesc.etsiEnDeviceType string Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
masterDeviceDesc.etsiEnDeviceEmissionsClass string Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
masterDeviceDesc.etsiEnTechnologyId string Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
masterDeviceDesc.etsiEnDeviceCategory string Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
requestType string The request type parameter is an optional parameter that can be used to modify an available spectrum request, but its use depends on applicable regulatory rules. It may be used, for example, to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the deviceDesc parameter for the device on whose behalf the request is made is required.

Response

If successful, this method returns a response body with the following structure:

{
  "jsonrpc": "2.0",
  "id": string,
  "result": {
    "type": "AVAIL_SPECTRUM_RESP",
    "version": "1.0",
    "timestamp": string,
    "deviceDesc": {
      "serialNumber": string,
      "manufacturerId": string,
      "modelId": string,
      "rulesetIds": [
        string
      ],
      "fccId": string,
      "fccTvbdDeviceType": string,
      "etsiEnDeviceType": string,
      "etsiEnDeviceEmissionsClass": string,
      "etsiEnTechnologyId": string,
      "etsiEnDeviceCategory": string
    },
    "spectrumSchedules": [
      {
        "eventTime": {
          "startTime": string,
          "stopTime": string
        },
        "spectra": [
          {
            "bandwidth": double,
            "frequencyRanges": [
              {
                "startHz": double,
                "stopHz": double,
                "maxPowerDBm": double,
                "channelId": string
              }
            ]
          }
        ]
      }
    ],
    "needsSpectrumReport": boolean,
    "maxTotalBwHz": double,
    "maxContiguousBwHz": double,
    "rulesetInfo": {
      "authority": string,
      "maxLocationChange": double,
      "maxPollingSecs": integer,
      "rulesetIds": [
        string
      ]
    },
    "databaseChange": {
      "databases": [
        {
          "name": string,
          "uri": string
        }
      ]
    }
  }
}
Property name Value Description Notes
type string The message type: AVAIL_SPECTRUM_RESP.

Required field
version string The PAWS version. Must be exactly 1.0.

Required field.
timestamp string The database includes a timestamp of the form YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339) in its available spectrum response. The timestamp should be used by the device as a reference for the start and stop times specified in the response spectrum schedules.
deviceDesc nested object The database must return, in its available spectrum response, the device descriptor information it received in the master device's available spectrum request.
deviceDesc.serialNumber string The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters.
deviceDesc.manufacturerId string The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length.
deviceDesc.modelId string The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length.
deviceDesc.rulesetIds[] list The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry.

For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset.
deviceDesc.fccId string Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters.
deviceDesc.fccTvbdDeviceType string Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
deviceDesc.etsiEnDeviceType string Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnDeviceEmissionsClass string Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnTechnologyId string Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types.
deviceDesc.etsiEnDeviceCategory string Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types.
spectrumSchedules[] list The available spectrum response must contain a spectrum schedule list. The list may be empty if spectrum is not available. The database may return more than one spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends on the applicable regulatory domain.
spectrumSchedules[].eventTime nested object The event time expresses when the spectrum profile is valid. It will always be present.
spectrumSchedules[].eventTime.startTime string The inclusive start of the event. It will be present.
spectrumSchedules[].eventTime.stopTime string The exclusive end of the event. It will be present.
spectrumSchedules[].spectra[] list A list of spectrum messages representing the usable profile. It will always be present, but may be empty when there is no available spectrum.
spectrumSchedules[].spectra[].bandwidth double The bandwidth (in Hertz) for which permissible power levels are specified. For example, FCC regulation would require only one spectrum specification at 6MHz bandwidth, but Ofcom regulation would require two specifications, at 0.1MHz and 8MHz. This parameter may be empty if there is no available spectrum. It will be present otherwise.
spectrumSchedules[].spectra[].frequencyRanges[] list The list of frequency ranges and permissible power levels. The list may be empty if there is no available spectrum, otherwise it will be present.
spectrumSchedules[].spectra[].frequencyRanges[].startHz double The required inclusive start of the frequency range (in Hertz).
spectrumSchedules[].spectra[].frequencyRanges[].stopHz double The required exclusive end of the frequency range (in Hertz).
spectrumSchedules[].spectra[].frequencyRanges[].maxPowerDBm double The maximum total power level (EIRP)—computed over the corresponding operating bandwidth—that is permitted within the frequency range. Depending on the context in which the frequency-range element appears, this value may be required. For example, it is required in the available-spectrum response, available-spectrum-batch response, and spectrum-use notification message, but it should not be present (it is not applicable) when the frequency range appears inside a device-capabilities message.
spectrumSchedules[].spectra[].frequencyRanges[].channelId string The database may include a channel identifier, when applicable. When it is included, the device should treat it as informative. The length of the identifier should not exceed 16 characters.
needsSpectrumReport boolean For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the spectrum schedule list is not empty; otherwise, the database will either return false or omit this parameter. If this parameter is present and its value is true, the device must send a spectrum use notify message to the database; otherwise, the device must not send the notification.
maxTotalBwHz double The database may return a constraint on the allowed maximum total bandwidth (in Hertz), which need not be contiguous. A regulatory domain may require the database to return this parameter. When this parameter is present in the available spectrum response, the device must apply this constraint to its spectrum-selection logic to ensure that total bandwidth does not exceed this value.
maxContiguousBwHz double The database may return a constraint on the allowed maximum contiguous bandwidth (in Hertz). A regulatory domain may require the database to return this parameter. When this parameter is present in the response, the device must apply this constraint to its spectrum-selection logic to ensure that no single block of spectrum has bandwidth that exceeds this value.
rulesetInfo nested object The database should return ruleset information, which identifies the applicable regulatory authority and ruleset for the available spectrum response. If included, the device must use the corresponding ruleset to interpret the response. Values provided in the returned ruleset information, such as maxLocationChange, take precedence over any conflicting values provided in the ruleset information returned in a prior initialization response sent by the database to the device.
rulesetInfo.authority string The regulatory domain to which the ruleset belongs is required. It must be a 2-letter country code. The device should use this to determine additional device behavior required by the associated regulatory domain.
rulesetInfo.maxLocationChange double The maximum location change in meters is required in the initialization response, but optional otherwise. When the device changes location by more than this specified distance, it must contact the database to get the available spectrum for the new location. If the device is using spectrum that is no longer available, it must immediately cease use of the spectrum under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
rulesetInfo.maxPollingSecs integer The maximum duration, in seconds, between requests for available spectrum. It is required in the initialization response, but optional otherwise. The device must contact the database to get available spectrum no less frequently than this duration. If the new spectrum information indicates that the device is using spectrum that is no longer available, it must immediately cease use of those frequencies under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response.
rulesetInfo.rulesetIds[] list The identifiers of the rulesets supported for the device's location. The database should include at least one applicable ruleset in the initialization response. The device may use the ruleset identifiers to determine parameters to include in subsequent requests. Within the context of the available-spectrum responses, the database should include the identifier of the ruleset that it used to determine the available-spectrum response. If included, the device must use the specified ruleset to interpret the response. If the device does not support the indicated ruleset, it must not operate in the spectrum governed by the ruleset.
databaseChange nested object A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.
databaseChange.databases[] list A required list of one or more databases. A device should update its preconfigured list of databases to replace (only) the database that provided the response with the specified entries.
databaseChange.databases[].name string The display name for a database.
databaseChange.databases[].uri string The corresponding URI of the database.