Default request referring to version v1explorer of the Google Spectrum Database API. This contains the host and root path used as a starting point for constructing service requests.

Represents the entirety of the methods and resources available for the Google Spectrum Database API service.

A region is represented using the polygonal shape.

See: geoLocationPolygon smart constructor.

Creates a value of GeoLocationPolygon with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• glpExterior

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).

A single geolocation on the globe.

See: geoLocationPoint smart constructor.

Creates a value of GeoLocationPoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• glpLatitude
• glpLongitude

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.

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.

The initialization response message communicates database parameters to the requesting device.

See: pawsInitResponse smart constructor.

Creates a value of PawsInitResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pirKind
• pirVersion
• pirRulesetInfo
• pirType
• pirDatabaseChange

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsInitResponse".

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

The rulesetInfo parameter must be included in the response. This parameter specifies the regulatory domain and parameters applicable to that domain. The database must include the authority field, which defines the regulatory domain for the location specified in the INIT_REQ message.

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

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.

The registration response message simply acknowledges receipt of the request and is otherwise empty.

See: pawsRegisterResponse smart constructor.

Creates a value of PawsRegisterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• prrKind
• prrVersion
• prrType
• prrDatabaseChange

Identifies what kind of resource this is. Value: the fixed string "spectrum#pawsRegisterResponse".

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

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

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.

The spectrum-use notification message which must contain the geolocation of the Device and parameters required by the regulatory domain.

See: pawsNotifySpectrumUseRequest smart constructor.

Creates a value of PawsNotifySpectrumUseRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pnsurSpectra
• pnsurLocation
• pnsurVersion
• pnsurType
• pnsurDeviceDesc

A spectrum list is required in the spectrum-use notification. The list specifies the spectrum that the device expects to use, which includes frequency ranges and maximum power levels. The list may be empty if the device decides not to use any of spectrum. For consistency, the psdBandwidthHz value should match that from one of the spectrum elements in the corresponding available spectrum response previously sent to the device by the database. Note that maximum power levels in the spectrum element must be expressed as power spectral density over the specified psdBandwidthHz value. The actual bandwidth to be used (as computed from the start and stop frequencies) may be different from the psdBandwidthHz value. As an example, when regulatory rules express maximum power spectral density in terms of maximum power over any 100 kHz band, then the psdBandwidthHz value should be set to 100 kHz, even though the actual bandwidth used can be 20 kHz.

The geolocation of the master device (the device that is sending the spectrum-use notification) to the database is required in the spectrum-use notification message.

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

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

Device descriptor information is required in the spectrum-use notification message.

A vCard-in-JSON message that contains only the fields needed for PAWS: - fn: Full name of an individual - org: Name of the organization - adr: Address fields - tel: Telephone numbers - email: Email addresses

See: vcard smart constructor.

Creates a value of Vcard with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vEmail
• vAdr
• vOrg
• vTel
• vFn

An email address that can be used to reach the contact.

The street address of the entity.

The organization associated with the registering entity.

A telephone number that can be used to call the contact.

The full name of the contact person. For example: John A. Smith.

This message is provided by the database to notify devices of an upcoming change to the database URI.

See: dbUpdateSpec smart constructor.

Creates a value of DBUpdateSpec with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dusDatabases

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.

The request message for a batch available spectrum query protocol.

See: pawsGetSpectrumBatchRequest smart constructor.

Creates a value of PawsGetSpectrumBatchRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pgsbrAntenna
• pgsbrMasterDeviceDesc
• pgsbrOwner
• pgsbrRequestType
• pgsbrVersion
• pgsbrType
• pgsbrLocations
• pgsbrCapabilities
• pgsbrDeviceDesc

Depending on device type and regulatory domain, antenna characteristics may be required.

When an available spectrum batch 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 in a separate parameter).

Depending on device type and regulatory domain, device owner information may be included in an available spectrum batch request. This allows the device to register and get spectrum-availability information in a single request.

The request type parameter is an optional parameter that can be used to modify an available spectrum batch request, but its use depends on applicable regulatory rules. For example, It may be used 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 device descriptor parameter for the device on whose behalf the batch request is made is required.

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

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

A geolocation list is required. This allows a device to specify its current location plus additional anticipated locations when allowed by the regulatory domain. At least one location must be included. Geolocation must be given as the location of the radiation center of the device's antenna. If a location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error if it does not support query by region. There is no upper limit on the number of locations included in a available spectrum batch request, but the database may restrict the number of locations it supports by returning a response with fewer locations than specified in the batch request. Note that geolocations must be those of the master device (a device with geolocation capability that makes an available spectrum batch request), whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability).

The master device may include its device capabilities to limit the available-spectrum batch response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.

When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for the device on whose behalf the request is made 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.

The schedule of spectrum profiles available at a particular geolocation.

See: geoSpectrumSchedule smart constructor.

Creates a value of GeoSpectrumSchedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gssLocation
• gssSpectrumSchedules

The geolocation identifies the location at which the spectrum schedule applies. It will always be present.

A list of available spectrum profiles and associated times. It will always be present, and at least one schedule must be included (though it may be empty if there is no available spectrum). More than one schedule may be included to represent future changes to the available spectrum.

The structure used to represent an organization and an email address.

See: vcardTypedText smart constructor.

Creates a value of VcardTypedText with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vttText

The text string associated with this item. For example, for an org field: ACME, inc. For an email field: smith'example.com.

The spectrum schedule element combines an event time with spectrum profile to define a time period in which the profile is valid.

See: spectrumSchedule smart constructor.

Creates a value of SpectrumSchedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ssSpectra
• ssEventTime

A list of spectrum messages representing the usable profile. It will always be present, but may be empty when there is no available spectrum.

The event time expresses when the spectrum profile is valid. It will always be present.

The structure used to represent a telephone number.

See: vcardTelephone smart constructor.

Creates a value of VcardTelephone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vtURI

A nested telephone URI of the form: tel:+1-123-456-7890.

This parameter contains device-owner information required as part of device registration. The regulatory domains may require additional parameters. All contact information must be expressed using the structure defined by the vCard format specification. Only the contact fields of vCard are supported: - fn: Full name of an individual - org: Name of the organization - adr: Address fields - tel: Telephone numbers - email: Email addresses Note that the vCard specification defines maximum lengths for each field.

See: deviceOwner smart constructor.

Creates a value of DeviceOwner with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• doOperator
• doOwner

The vCard contact information for the device operator is optional, but may be required by specific regulatory domains.

The vCard contact information for the individual or business that owns the device is required.

The start and stop times of an event. This is used to indicate the time period for which a spectrum profile is valid. Both times are expressed using the format, YYYY-MM-DDThh:mm:ssZ, as defined in RFC3339. The times must be expressed using UTC.

See: eventTime smart constructor.

Creates a value of EventTime with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• etStartTime
• etStopTime

The inclusive start of the event. It will be present.

The exclusive end of the event. It will be present.

The request message for the available spectrum query protocol which must include the device's geolocation.

See: pawsGetSpectrumRequest smart constructor.

Creates a value of PawsGetSpectrumRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pgsrAntenna
• pgsrMasterDeviceDesc
• pgsrLocation
• pgsrOwner
• pgsrRequestType
• pgsrVersion
• pgsrType
• pgsrCapabilities
• pgsrDeviceDesc

Depending on device type and regulatory domain, the characteristics of the antenna may be required.

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).

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.

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.

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.

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

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field.

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.

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.

Antenna characteristics provide additional information, such as the antenna height, antenna type, etc. Whether antenna characteristics must be provided in a request depends on the device type and regulatory domain.

See: antennaCharacteristics smart constructor.

Creates a value of AntennaCharacteristics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• acHeight
• acHeightType
• acHeightUncertainty

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.

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.

The height uncertainty in meters. Whether this is required depends on the regulatory domain.

The device validation response message.

See: pawsVerifyDeviceResponse smart constructor.