SwaggerUI Rapidoc

Download

Device Location Retrieval

 0.3.0

OAS 3.0

https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/kDSbOYCTWnAg6QJb/products/LiEVDSD2qJ7CCOFd/contents/swagger/WfOR2a8FcfWJAPZ1/location-retrieval.v0.3.0.OD.yaml

This API provides the ability to retrieve a device location.

Introduction

With this API, API consumers can retrieve the area where a certain user device is localized. The area provided in the response could be described:

by a circle determined by coordinates (latitude and longitude) and a radius.
by a simple polygon delimited by segments connecting consecutively an array of coordinates (points). The last point connects to the first point to delimit a closed shape bounded with straight sides.

The retrieved shape depends on the network conditions at the device's location and any of the supported shapes could be received.

The requester could optionally ask for a freshness of the localization information by providing a maxAge ("I want a location not older than 600 seconds").

The result accuracy depends on the network's ability and accuracy to locate the device.

Additionally to location information, the answer will also provide indication about the location time.

Location retrieval API could be useful in scenarios such as:

Fraud protection to ensure a given user is located in the region, country or location authorized for financial transactions
Verify the GPS coordinates reported by the app on a device to ensure the GPS was not faked e.g. for content delivery with regional restrictions
Contextual-based advertising, to trigger advertising after verifying the device is in the area of interest
Smart Mobility (Vehicle/bikes renting): obtain the location of a vehicle/bike to guarantee they are rented correctly

Note: Location is in most jurisdictions considered to be sensitive data and thereby consent by device owner/user must be verified before providing it to the developer.

Relevant terms and definitions

Device: A device refers to any physical entity that can connect to a network and participate in network communication.
Area: It specifies the geographical surface where a device may be physically located.
Max Age: Maximum age of the location information which is accepted for the location retrieval (in seconds).
- Absence of maxAge means that "any age" is acceptable for the client. In other words, this is like maxAge=infinite. The system will return lastLocationTime in the response. If the system is not able to provide location, an error 404 with code LOCATION_RETRIEVAL.DEVICE_NOT_FOUND is sent back.
- maxAge=0 means that a fresh calculation is requested by the client. If the system is not able to provide the fresh location, an error 422 with code LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_AGE is sent back.
Last Location Time : Last date and time when the device was localized.

API Functionality

The API exposes a single endpoint/operation:

/retrieve : Retrieve where the device is localized. The operation returns:
- a localization defined either as a circle, with the center specified by the latitude and longitude, and a radius for answer accuracy, or as polygon defined by the array of points delimiting its boundary.
- a timestamp with the location information freshness.

Authorization and authentication

The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.

Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.

It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.

Identifying a device from the access token

This specification defines the device object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API.

Handling of device information:

Optional device object for 3-legged tokens:

When using a 3-legged access token, the device associated with the access token must be considered as the device for the API request. This means that the device object is not required in the request, and if included it must identify the same device, therefore it is recommended NOT to include it in these scenarios to simplify the API usage and avoid additional validations.

Validation mechanism:

The server will extract the device identification from the access token, if available.
If the API request additionally includes a device object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token.
If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token.

Error handling for unidentifiable devices:

If the device object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 UNIDENTIFIABLE_DEVICE error.

Restrictions for tokens without an associated authenticated identifier:

For scenarios which do not have a single device identifier associated to the token during the authentication flow, e.g. 2-legged access tokens, the device object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens.

Further info and support

(FAQs will be added in a later version of the documentation)

Apache 2.0

Project documentation at Camara

Servers

Computed URL:https://api.orange.com/camara/orange-lab/location-retrieval/v0.3

Server variables

apiRoot
basePath

Location retrieval
Retrieve the location of a device

HTTP status code	Reason	Response model
400	List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value	{ "code": 28, "message": "Invalid query-string parameter value", "description": "One or more query-string parameters contain invalid values." }
401	List of supported error codes: - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials	{ "code": 42, "message": "Expired credentials", "description": "The requested service needs credentials, and the ones provided were out-of-date." }
403	List of supported error codes: - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests	{ "code": 53, "message": "Too many requests", "description": "The application has made too many calls and has exceeded the rate limit for this service." }
404	List of supported error codes: - 60: Resource not found	{ "code": 60, "message": "Resource not found", "description": "The requested URI or the requested resource does not exist." }
405	List of supported error codes: - 61: Method not allowed	{ "code": 61, "message": "Method not allowed", "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'" }
406	List of supported error codes: - 62: Not acceptable	{ "code": 62, "message": "Not acceptable", "description": "The Accept incoming header does not match any available content-type." }
408	List of supported error codes: - 63: Request time-out	{ "code": 63, "message": "Request time-out", "description": "The server timed out waiting for the incoming request." }
409	List of supported error codes: - 69: Conflict	{ "code": 69, "message": "Conflict", "description": "The request could not be completed due to a conflict with the current state of the resource." }
411	List of supported error codes: - 64: Length required	{ "code": 64, "message": "Length required", "description": "The request did not specify a Content-Length header, which is required by the requested resource." }
412	List of supported error codes: - 65: Precondition failed	{ "code": 65, "message": "Precondition failed", "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match." }
413	List of supported error codes: - 66: Request entity too large	{ "code": 66, "message": "Request entity too large", "description": "The body of the request/response (PATCH, POST and PUT methods) is larger than the server is willing or able to process." }
414	List of supported error codes: - 67: Request-URI too long	{ "code": 67, "message": "Request-URI too long", "description": "The URI provided was too long for the server to process." }
415	List of supported error codes: - 68: Unsupported Media Type	{ "code": 68, "message": "Unsupported Media Type", "description": "The format of the posted body is not supported by the endpoint." }
429	List of supported error codes: - 53: Too many requests	{ "code": 53, "message": "Too many requests", "description": "The application has made too many calls and has exceeded the rate limit for this service." }
500	List of supported error codes: - 1: Internal error	{ "code": 1, "message": "Internal error", "description": "Generic failure message, used if no more precise code can be provided." }
502	List of supported error codes: - 1: Internal error - 3: Bad gateway	{ "code": 1, "message": "Bad gateway", "description": "A runtime execution error occurs (RaiseFault)." }
503	List of supported error codes: - 5: The service is temporarily unavailable - 6: Orange API is over capacity, retry later !	{ "code": 6, "message": "Orange API is over capacity, retry later !", "description": "The service faces too much requests and can not handle the call." }
504	List of supported error codes: - 6: Gateway timeout	{ "code": 6, "message": "Gateway timeout", "description": "No response was received in time from a backend server acting as gateway or proxy." }

Device Location Retrieval - CAMARA - Sandbox

0.3 (current)

0.1 (deprecated)

Introduction

Relevant terms and definitions

API Functionality

Authorization and authentication

Identifying a device from the access token

Handling of device information:

Optional device object for 3-legged tokens:

Validation mechanism:

Error handling for unidentifiable devices:

Restrictions for tokens without an associated authenticated identifier:

Further info and support

Execute location retrieval for a user equipment

Device Location Retrieval
0.3.0
OAS 3.0

Introduction

Relevant terms and definitions

API Functionality

Authorization and authentication

Identifying a device from the access token

Handling of device information:

Optional device object for 3-legged tokens:

Validation mechanism:

Error handling for unidentifiable devices:

Restrictions for tokens without an associated authenticated identifier:

Further info and support

Server variables

Location retrieval
Retrieve the location of a device

Introduction

Relevant terms and definitions

API Functionality

Authorization and authentication

Identifying a device from the access token

Handling of device information:

Optional device object for 3-legged tokens:

Validation mechanism:

Error handling for unidentifiable devices:

Restrictions for tokens without an associated authenticated identifier:

Further info and support

Execute location retrieval for a user equipment

Device Location Retrieval 0.3.0 OAS 3.0

Introduction

Relevant terms and definitions

API Functionality

Authorization and authentication

Identifying a device from the access token

Handling of device information:

Optional device object for 3-legged tokens:

Validation mechanism:

Error handling for unidentifiable devices:

Restrictions for tokens without an associated authenticated identifier:

Further info and support

Server variables

Location retrievalRetrieve the location of a device

Schemas

Common errors

Device Location Retrieval
0.3.0
OAS 3.0

Location retrieval
Retrieve the location of a device