AutomaticDocumentFeederResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
     "title": "Automatic Document Feeder",
     "version": "2019-02-22",
     "license": {
        "name": "OCF Data Model License",
        "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
        "x-copyright": "Copyright 2018-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": {
    "/AutomaticDocumentFeederResURI" : {
      "get": {
        "description": "This Resource describes the state of an automatic document feeder, typically used with a scanner.\nThe Property \"adfstates\" and \"currentAdfState\" are read only.\nThe Property \"adfStates\" is an array of the possible operational states.\nThe Property \"adfProcessing\" is the OK state, other states are errors or require 'user attention'.\nThe currentAdfState is the current value of the ADF state on the device.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.automaticdocumentfeeder"],
                  "if": ["oic.if.s", "oic.if.baseline"],
                  "adfStates": ["adfProcessing", "adfEmpty", "adfJam", "adfLoaded", "adfMispick", "adfHatchOpen", "adfDuplexPageTooShort", "adfDuplexPageTooLong", "adfMultipickDetected", "adfInputTrayFailed", "adfInputTrayOverloaded"],
                  "currentAdfState": "adfProcessing"
                },
              "schema": { "$ref": "#/definitions/AutomaticDocumentFeeder" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "AutomaticDocumentFeeder" : {
      "properties": {
         "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.automaticdocumentfeeder"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "adfStates": {
          "description": "The array of the possible adf states.",
          "items": {
            "type": "string"
          },
          "readOnly": true,
          "uniqueItems": true,
          "type": "array"
        },
        "currentAdfState": {
          "description": "The current adf state.",
          "readOnly": true,
          "type": "string"
        },
        "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.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["adfStates", "currentAdfState"]
    }
  }
}