Query parameters

• page[number] integer

  page number

• page[size] integer

  items per page

• filter[poiType] string

  Filter for poi type, no filter returns all types

  Values are GasStation or SpeedCamera.

• filter[appId] string(uuid)

  Filter id for app id, no filter returns pois for all apps

Responses

• 200 application/vnd.api+json

  OK

  Hide response attributes Show response attributes object

  • data array[object]
    Hide data attributes Show data attributes object

    • type string

      POI type this applies to

      Values are GasStation or SpeedCamera.

    • id string(uuid)

      POI ID

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • countryId string

        Country this policy applies to (as ISO3166Alpha2)

      • position object

        https://tools.ietf.org/html/rfc7946#section-3.1.2

        Hide position attributes Show position attributes object

        • type string

          Value is Point.

        • coordinates array[number(float)]

          https://tools.ietf.org/html/rfc7946

      • boundary object

        https://tools.ietf.org/html/rfc7946#section-3.1.6; used as bounding box

        Hide boundary attributes Show boundary attributes object

        • type string

          Value is Polygon.

        • coordinates array[array]

          https://tools.ietf.org/html/rfc7946

      • data array[object]

        a JSON field containing POI specific data

        Hide data attributes Show data attributes object

        • field string

          Values are name, brand, street, houseNumber, postCode, place, holidayIdentifier, operatingHours, or fuelPrices.

        • value string

          escaped json

      • metadata array[object]

        a JSON field containing information about data field origin and update time

        Hide metadata attributes Show metadata attributes object

        • field string

          Values are name, brand, street, houseNumber, postCode, place, holidayIdentifier, operatingHours, or fuelPrices.

        • SourceId string(uuid)

          Source ID

        • UpdatedAt string(date-time)
      • active boolean
      • createdAt string(date-time)
      • updatedAt string(date-time)
      • lastSeenAt string(date-time)
      • references array[string]

        References are PRNs to external and internal resources that are represented by this poi

    • relationships object
      Hide relationships attributes Show relationships attributes object

      • referenceStatuses object
        Hide referenceStatuses attribute Show referenceStatuses attribute object

        • data array[object]
          Hide data attributes Show data attributes object

          • type string

            Value is referenceStatus.

          • id string(uuid)

            Service Provider resource PRN

      • sucessorOf object
        Hide sucessorOf attribute Show sucessorOf attribute object

        • data array[object]
          Hide data attributes Show data attributes object

          • type string

            Value is gasStation.

          • id string(uuid)

            GasStation ID which was superseded by this gas station

  • included array[object]
    Hide included attributes Show included attributes object

    • type string

      Type

      Value is referenceStatus.

    • id string

      Service Provider PRN

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • status string

        Availability status of the referenced resource

        Values are online or offline.

      • updatedAt string(date-time)

        Time of status last update (iso8601)

• 400 application/vnd.api+json

  Bad request

  Hide response attribute 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed
• 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"
            }
        ]
    }
  

  Hide response attribute 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed
• 406 application/vnd.api+json

  The specified accept header is invalid

  Hide response attribute 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed
• 500 application/vnd.api+json

  Internal server error

  Hide response attribute 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed