nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches

◆ nrf_cloud_rest_agnss_data_get()

int nrf_cloud_rest_agnss_data_get ( struct nrf_cloud_rest_context *const  rest_ctx,
struct nrf_cloud_rest_agnss_request const *const  request,
struct nrf_cloud_rest_agnss_result *const  result 
)

#include <include/net/nrf_cloud_rest.h>

nRF Cloud Assisted GNSS (A-GNSS) data request.

Parameters
[in,out]rest_ctxContext for communicating with nRF Cloud's REST API.
[in]requestData to be provided in API call.
[in,out]resultOptional; Additional buffer for A-GNSS data. This is necessary when the A-GNSS data from the cloud is larger than the fragment size specified by rest_ctx->fragment_size.
Return values
0If successful. If result is NULL and the A-GNSS data is larger than the fragment size specified by rest_ctx->fragment_size, a positive value is returned, which indicates the size (in bytes) of the necessary result buffer. Otherwise, a (negative) error code is returned:
  • -EINVAL will be returned, and an error message printed, if invalid parameters are given.
  • -ENOENT will be returned if there was no A-GNSS data requested for the specified request type.
  • -ENOBUFS will be returned, and an error message printed, if there is not enough buffer space to store retrieved AGNSS data.
  • See
    embed:rst:inline :ref:`nrf_cloud_rest_failure` 
    for all other possible error codes.