Device Location Retrieval – CAMARA Sandbox – Orange lab (0.1) API – API reference

Introduction

With this API, customers 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 subscriber'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

Location-based advertising: trigger targeted advertising after retrieving the area where the user is localized

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

Last Location Time : Last date and time when the device was localized.

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." }

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 - Orange lab 0.1 Beta

Introduction

Relevant terms and definitions

API Functionality

Further info and support

Execute location retrieval for a user equipment

Location retrieval API
0.1.0-rc2
OAS 3.0

Introduction

Relevant terms and definitions

API Functionality

Further info and support

Server variables

Location retrieval

Common errors

API Categories

Resources

About us and Contact

Introduction

Relevant terms and definitions

API Functionality

Further info and support

Execute location retrieval for a user equipment

Location retrieval API 0.1.0-rc2 OAS 3.0

Introduction

Relevant terms and definitions

API Functionality

Further info and support

Server variables

Location retrieval

Schemas

Common errors

Location retrieval API
0.1.0-rc2
OAS 3.0