PHP Sigfox Client

CoveragesGlobalPredictions

Table of Contents

calculateBulk()  : AsyncResponse<CoveragesGlobalPredictionsCalculateBulkResponse, GlobalCoverageBulkResponse>
Starting the computation of the coverage margins for multiple points, for each redundancy level.
get()  : GlobalCoverageResponse
Get the coverage margins for multiple points, for each redundancy level.
getOne()  : CoveragesGlobalPredictionsGetOneResponse
Get coverage margins for a selected latitude and longitude, for each redundancy level.

Methods

calculateBulk()

Starting the computation of the coverage margins for multiple points, for each redundancy level.

public calculateBulk(GlobalCoverageRequest|array<string|int, mixed>|null $payload) : AsyncResponse<CoveragesGlobalPredictionsCalculateBulkResponse, GlobalCoverageBulkResponse>

For more information please refer to the Global Coverage API article.

Parameters
$payload : GlobalCoverageRequest|array<string|int, mixed>|null
Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
AsyncResponse<CoveragesGlobalPredictionsCalculateBulkResponse, GlobalCoverageBulkResponse>

get()

Get the coverage margins for multiple points, for each redundancy level.

public get(GlobalCoverageRequest|array<string|int, mixed>|null $payload) : GlobalCoverageResponse

Sigfox recommends to: -use the bulk endpoint instead when requesting a large number of locations -not request more than 200 locations at a time -wait for the result to be returned before requesting again (avoid multithreading) For more information please refer to the Global Coverage API article.

Parameters
$payload : GlobalCoverageRequest|array<string|int, mixed>|null
Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
GlobalCoverageResponse

getOne()

Get coverage margins for a selected latitude and longitude, for each redundancy level.

public getOne([CoveragesGlobalPredictionsGetOne|array<string|int, mixed>|null $request = null ]) : CoveragesGlobalPredictionsGetOneResponse

For more information please refer to the Global Coverage API article.

Parameters
$request : CoveragesGlobalPredictionsGetOne|array<string|int, mixed>|null = null

The query and body parameters to pass

Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
CoveragesGlobalPredictionsGetOneResponse

Search results