Query for location-based apps

GET /apps/query

These location-based PACE apps deliver additional services for PACE customers based on their current position. You can (or should) trigger this whenever:

A longer stand-still is detected
The engine is turned off
Every 5 seconds if the user "left the road"

Please note that calling this API is very cheap and can be done regularly.

Query parameters

filter[latitude] number(float) Required

Latitude
filter[longitude] number(float) Required

Longitude
filter[appType] string

Type of location-based app

Value is fueling.

Responses

200 application/vnd.api+json

OK
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  type string
  
  Type
  
  Value is locationBasedAppWithRefs.
  
  id string(uuid)
  
  Location-based app ID
  
  attributes object
  
  Hide attributes attributes Show attributes attributes object
  
  appType string
  
  Value is fueling.
  
  title string
  
  subtitle string
  
  logoUrl string
  
  Logo URL
  
  pwaUrl string
  
  Progressive web application URL. The URL satisfies the following criteria:
  The URL responds with text/html on a GET request
  
  The response contains HTTP caching headers e.g. Cache-Control and ETag
  
  HTTP GET request on the URL with an ETag will return 304 (Not Modified), if the content didn't change
  
  If 503 (Service Unavailable) is returned the request should be retried later
  
  If 404 (Not Found) is returned the URL is invalidated and a new app should be requested
  
  androidInstantAppUrl string
  
  Android instant app URL
  
  cache string
  
  A location-based app is by default loaded on approaching. Some apps should be loaded in advance. They have the cache set to preload.
  
  Values are approaching or preload. Default value is approaching.
  
  references array[string]
  
  References are PRNs to external and internal resources that are related to the query
  
  createdAt string(date-time)
  
  Time of LocationBasedApp creation (iso8601 without time zone)
  
  updatedAt string(date-time)
  
  Time of LocationBasedApp last update (iso8601 without time zone)
  
  deletedAt string(date-time)
  
  Time of LocationBasedApp deletion (iso8601 without time zone)

400 application/vnd.api+json

Bad request

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.

401 application/vnd.api+json

OAuth token missing or invalid or a linked identity is missing.

Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.

This is not relevant for most use-cases.

The specific error code that identifies a missing linked identity is missing-linked-identity

Example:

  {
      "errors": [
          {
              "id": "cbgmhslmp1o9or9kh1p0",
              "title": "Missing linked identity for authorized access",
              "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity",
              "status": "401",
              "code": "missing-linked-identity"
          }
      ]
  }

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.

406 application/vnd.api+json

The specified accept header is invalid

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.

500 application/vnd.api+json

Internal server error

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.