Sign in
Assisted GPS

GetFileSize

<div class="nrf-note"> <p><b>Cloud-to-cloud — authorize with an Organization Auth Token.</b><br><code>https://api.location.nrfcloud.com/v1/organizations/{organizationSlug}/projects/{projectSlug}/location/agps</code></p> <p><b>Device-to-cloud — authorize with a JSON Web Token.</b><br><code>https://api.location.nrfcloud.com/v1/location/agps</code></p> </div> <div style="background-color: #f8d7da; color: #721c24; text-align: center; border: 1px solid #f5c6cb; border-radius: .25rem; padding: .75rem 1.25rem">This endpoint has been deprecated. Please use the <a href="#tag/GNSS/operation/GetAssistanceDataSize">GNSS GetFileSize endpoint</a> instead.</div>

This endpoint is for advanced use cases where you need to set the Range header to something other than the payload size. Normally you will just set the Range header to the payload limit for your modem. It gets the payload size of the modem parameters. This endpoint returns the totalBytes in the Content-Length response header, no body. The Content-Length header in the response can be used in the Range header for a subsequent GET request (same query string, just GET instead of HEAD + Range header).

curl -I "$API_HOST/v1/location/agps" -H "Authorization: Bearer $JWT"

Type definitions:

  • 1 = GPS UTC
  • 2 = GPS Ephemerides
  • 3 = GPS Almanac
  • 4 = Klobuchar Ionospheric Correction
  • 5 = Nequick Ionospheric Correction
  • 6 = GPS Time of Week
  • 7 = GPS System Clock
  • 8 = Location (lat/lon of cell)
  • 9 = GPS Integrity
head/location/agps

Query parameters

requestType'rtLocation' | 'rtAssistance' | 'custom'

Type of data to be returned. Deprecated because the requestType is inferred from the request data.

customTypesNrfGpsMessageType[]

Deprecated in favor of the 'types' param.

typesNrfGpsMessageType[]

Type of assistance data (see description above). Defaults to [1, 2, 3, 4, 6, 7, 9]

mccinteger

Mobile Country Code. As defined in <a href="https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.212B-2018-PDF-E.pdf" target="_blank">ITU-T E.212</a>.

Example:310
number double
OR
string
tacinteger

Tracking Area Code (TAC). Identifies a group of LTE cells in a certain region (Tracking Area). See <a href="https://www.etsi.org/deliver/etsi_ts/123000_123099/123003/17.09.00_60/ts_123003v170900p.pdf" target="_blank">ETSI TS 123 003, section 19.4.2.3</a> for more details.

Example:13601
eciinteger

E-UTRA Cell Identifier (ECI), 28 bits (20 bits eNodeB and 8 bits Cell ID). Calculated using "(eNodeB-ID * 256) + Sector-ID". Range 0 .. 268435455. See <a href="https://www.etsi.org/deliver/etsi_ts/123000_123099/123003/17.09.00_60/ts_123003v170900p.pdf" target="_blank">ETSI TS 123 003, section 19.6</a> for more details.

Example:167899669
rsrpnumber double

Reference Signal Received Power. Measured in dBm. See <a href="https://www.rfwireless-world.com/Terminology/LTE-RSRP-vs-RSRQ.html" target="_blank">this page</a> for more details. Range -157..-44

Example:-90
filteredboolean

Send this flag if you want to receive ephemeris for only satellites in view. nRF Cloud will return ephemeris for up to 16 satellites. Cell data (eci, mcc, mnc, tac) is required. Defaults to false.

Example:true
masknumber double

Filtered ephemeris mask angle. Only works in conjunction with the filtered flag. Controls the mask angle for which the satellites are filtered. Range 0..90 Defaults to 5

Example:5

Response

Body is empty. Response "Content-Length" header contains the size of the file (bytes).

AssistanceBuffer required

Changes

No recorded changes to this endpoint across all 1 revision of this API.