DRLCResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Demand Response Load Control (DRLC).",
    "version": "2019-07-09",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/DRLCResURI" : {
      "get": {
        "description": "This Resource describes any to be applied or currently being applied DRLC signal.\nThe Property \"DRType\" is the ApplianceLoadReductionType defined in Zigbee/HA Smart Energy Profile 2.0.\nThe Property \"start\" is a string containing an RFC3339 encoded start time.\nThe Property \"duration\" value is in minutes.\nThe Property \"Override\" indicates whether the consumer has overridden the request (true) or not (false).\nThe Resource provides the current DRLC action that is being applied.\nA duration of 0 (zero) means that no DRLC is currently active.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description": "",
              "x-example":
                {
                  "rt": ["oic.r.energy.drlc"],
                  "if": ["oic.if.a", "oic.if.baseline"],
                  "DRType": 1,
                  "start": "2015-01-09T16:45:00Z",
                  "duration": 10,
                  "override": false,
                  "drlevel": 2,
                  "mandate": true
                },
              "schema": { "$ref": "#/definitions/DRLC" }
            }
        }
      },
      "post": {
        "description": "Provides the DRLC action to be applied to the device or updates an existing action.",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {"$ref": "#/definitions/DRLC"},
            "x-example": {
              "DRType": 1,
              "start": "2015-01-09T17:00:00Z",
              "duration": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description" : "Indicates that the target DRLC resource was changed.\nThe new resource attributes are provided in the response.",
            "x-example": {
              "DRType": 1,
              "start": "2015-01-09T17:00:00Z",
              "duration": 15,
              "override": false
            },
            "schema": {"$ref": "#/definitions/DRLC"}
          }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "DRLC" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.energy.drlc"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "start": {
          "description": "The start time for the application of DR.",
          "type": "string",
          "format": "date-time"
        },
        "duration": {
          "description": "The duration of the to be applied DR type in minutes. A value of 0 means no applied DR.",
          "type": "integer",
          "minimum": 0
        },
        "override": {
          "description": "Whether the consumer has overriden the application of DR.",
          "type": "boolean"
        },
        "DRType": {
          "description": "The to be applied demand-response type.",
          "type": "integer"
        },
        "drlevel": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3,
          "description": "Indicator of the strength of the DR response that is requested; 0-0%, 1-30%, 2-50%, 3-70%"
        },
        "mandate" : {
          "type": "boolean",
          "description": "Whether overriding the DR request by the consumer is allowed"
        },
        "n": {
            "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
            "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.a",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["DRType"]
    }
  }
}