Delete a profile by time range - Enectiva REST API

This endpoint enables clients to remove a profile selected by the combination of importId, suit and a time range. Each profile to delete is sent in a separate HTTP request. Sending profiles to delete from multiple servers might hit rate limiting limits.
Removes a profile selected by the combination of importId, suit and time range.

The time range is specified by the from and to. A profile is selected if the stored profile’s range exactly matches the requested time range.

the request is rejected with 409 if the requested time range has a non‑empty intersection with the range of one profile but does not match it exactly.

the request is rejected with 409 if the requested time range has a non‑empty intersection with the ranges of two or more profiles.

Each request is validated against these rules:

from, to are required fields and must be non-empty

from and to must conform to time format defined in RFC3339, the time will be truncated to whole seconds

time range defined by from and to must select exactly one profile.

In case of success, the response contains the deleted profile.

This endpoint requires an Access token. The Import token auth method is deprecated and remains available only for backward compatibility

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/vnd.api+json

Example

{
  "data": {
    "type": "profiles",
    "attributes": {
      "from": "2015-11-18T09:54:23+01:00",
      "to": "2015-11-18T09:59:23+01:00"
    }
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Body

Example

{
    "data": {
        "attributes": {
            "customer_uuid": "11e7e767-6f74-4994-b607-158ff7f7445e",
            "from": "2015-11-18T09:54:23+01:00",
            "import_id": "40AABB_007",
            "suit": "default",
            "to": "2015-11-18T09:59:23+01:00",
            "unit": "kW",
            "value": 123456.78
        },
        "id": "1",
        "type": "profiles"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠406Not Acceptable

🟠409Conflict

🟠415Unsupported Media Type

🟠429Too Many Requests

🔴500Server Error