Create idle periods for meters
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
meter_idle_periods
array of objects
required
A list of objects containing details about the meter and idle periods to be created.
meter_idle_periods* ADD object
content-type
string
enum
Defaults to application/json
Generated from available request content types
application/jsontext/csv
Allowed:
application/json``text/csv
``200 Idle periods are created successfully for at least one meter.
object
meter_idle_periods
array of objects
required
A list of objects containing details about the meter and created idle periods.
meter_idle_periods* object
A list of objects containing details about the meter and created idle periods.
meter_id
uuid
required
The uuid of the meter for which idle periods were created.
idle_periods
array of objects
required
The list of created idle periods for meter.
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.
``400 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.
``422 - Multiple occurrences of the same meter are present in the request body. - The start date of one or more 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.
Base URL
https://api.staging.leap.energy/v1.1/enrollment/meters/idle_periods
xxxxxxxxxx
curl --request POST \
--url https://api.staging.leap.energy/v1.1/enrollment/meters/idle_periods \
--header 'accept: application/json' \
--header 'content-type: application/json'
xxxxxxxxxx
{
"meter_idle_periods": [
{
"meter_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"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"
}
]
},
{
"meter_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"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"
}
]
}
]
}