JouloDocs

Resolve a BootNotification to a catalog model

Resolves the chargePointVendor and chargePointModel from an OCPP BootNotification to a catalog model, with the same resolver the Joulo OCPP gateway uses. An unknown pair is a normal 200 with resolved false and the brand's MID models as suggestions. Any valid CPO token may call this route, whatever its scopes.

GET
/v1/catalog/chargers/resolve
AuthorizationBearer <token>

OAuth 2.0 client credentials for a CPO client bound to one partner. Request a token with grant_type client_credentials and send client_id and client_secret in the body, as JSON or form data. The token endpoint does not accept HTTP Basic client authentication. The token lasts one hour and has no refresh token. Omit scope to get every scope your client holds. The /v1 routes refuse user tokens and personal API tokens.

In: header

Query Parameters

vendorstring

chargePointVendor exactly as the charger reports it. The server trims it and keeps the first 120 characters.

Length1 <= length
modelstring

chargePointModel exactly as the charger reports it. The server trims it and keeps the first 120 characters.

Length1 <= length

Response Body

curl -X GET "https://api.joulo.nl/functions/v1/api/v1/catalog/chargers/resolve?vendor=string&model=string"
{
  "resolved": true,
  "vendor": "string",
  "model": "string",
  "catalog_charger_id": "45aeec55-e46d-42b6-a990-2b5f65ab05a6",
  "brand": "string",
  "catalog_model": "string",
  "mid_meter": true,
  "detail": "string",
  "suggestions": [
    {
      "catalog_charger_id": "45aeec55-e46d-42b6-a990-2b5f65ab05a6",
      "brand": "string",
      "model": "string"
    }
  ]
}
{
  "error": "vendor_and_model_required",
  "detail": "string"
}
{
  "error": "Missing or invalid API token"
}
{
  "error": "cpo_token_required",
  "detail": "string",
  "required_scope": "string"
}
{
  "error": "Too many requests",
  "retry_after_seconds": 0
}
{
  "error": "catalog_lookup_failed",
  "detail": "string"
}
{
  "error": "string"
}