Create idle periods for meter

URL Expired

The URL for this request expired after 30 days.

Request Parameters

meter_id
string
required
The unique identifier of the meter.

idle_periods
array of objects
required
A list of idle periods to be created.

Response

200

Idle periods are created successfully.

idle_periods
array of objects
required
The list of created idle periods.

idle_periods
object
The list of created idle periods for meter.

• start_date
  date
  required
  The start date of the idle period. The date is inclusive. Date format: yyyy-MM-dd.

• end_date
  date
  The end date of the idle period. The date is exclusive. Date format: yyyy-MM-dd.

• reason
  string
  required
  A reason specifying why the meter will be idle during the given period.

Error Codes

400

• Meter id is not a valid UUID.
• Reason is not specified for an idle period.

401

You are not authorized to perform this operation.

403

You do not have the necessary permissions for this operation.

404

Meter with the given uuid is not found.

422

• The start date of any of the idle periods is on the same day as the meter creation date, or less than 1 day from now.
• The end of an idle period is not at least one day after the start.

Example Request

curl --request POST \
     --url https://api.staging.leap.energy/v1.1/enrollment/meters//idle_periods \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

{
  "idle_periods": [
    {
      "end_date": "2000-01-23",
      "reason": "reason",
      "start_date": "2000-01-23"
    },
    {
      "end_date": "2000-01-23",
      "reason": "reason",
      "start_date": "2000-01-23"
    }
  ]
}