| Open API Documentation |
|---|
{
"basePath": "/v2",
"consumes": [
"application/json"
],
"definitions": {
"BadRequest": {
"properties": {
"errors": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"items": {
"properties": {
"code": {
"description": "400",
"type": "string"
},
"message": {
"description": "Bad Request",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "Bad Request",
"type": "string"
},
"status": {
"description": "400",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
},
"EVSEEventDefinition": {
"properties": {
"Event": {
"description": "EVSE Event data., **Type:** unknown",
"type": "object"
}
},
"type": "object"
},
"EnterDiagnosticsDefinition": {
"properties": {
"Mode": {
"description": "Mode value, **Type:** 8-bit Enumeration",
"type": "number"
}
},
"type": "object"
},
"Forbidden": {
"properties": {
"errors": {
"description": "The client does not have necessary permissions for the resource",
"items": {
"properties": {
"code": {
"description": "403",
"type": "string"
},
"message": {
"description": "Forbidden",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "Forbidden",
"type": "string"
},
"status": {
"description": "403",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
},
"MethodNotAllowed": {
"properties": {
"errors": {
"description": "A request was made of a resource using a request method not supported by that resource",
"items": {
"properties": {
"code": {
"description": "405",
"type": "string"
},
"message": {
"description": "Method Not Allowed",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "Method Not Allowed",
"type": "string"
},
"status": {
"description": "405",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
},
"NoContentResponse": {
"properties": {
"errors": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"items": {
"properties": {
"code": {
"description": "204",
"type": "string"
},
"message": {
"description": "No Content",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "No Content",
"type": "string"
},
"status": {
"description": "204",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
},
"NotFound": {
"properties": {
"errors": {
"description": "The requested resource could not be found but may be available again in the future",
"items": {
"properties": {
"code": {
"description": "404",
"type": "string"
},
"message": {
"description": "Not Found",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "Not Found",
"type": "string"
},
"status": {
"description": "404",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
},
"RequestTimeout": {
"properties": {
"errors": {
"description": "The server timed out waiting for the request",
"items": {
"properties": {
"code": {
"description": "408",
"type": "string"
},
"message": {
"description": "Request Timeout",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "Request Timeout",
"type": "string"
},
"status": {
"description": "408",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
},
"Unauthorized": {
"properties": {
"errors": {
"description": "Authentication is required and has failed or has not yet been provided",
"items": {
"properties": {
"code": {
"description": "401",
"type": "string"
},
"message": {
"description": "Unauthorized",
"type": "string"
}
},
"required": [
"message",
"code"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "Unauthorized",
"type": "string"
},
"status": {
"description": "401",
"type": "number"
}
},
"required": [
"message",
"status",
"errors"
],
"type": "object"
}
},
"host": "api.smartenit.io",
"info": {
"description": "Processor created by Smartenit to represent an Electric Vehicle Station Equipment (EVSE). Attributes and methods for an EVSE type device.",
"title": "EVSEServer Processor",
"version": "2.0.0"
},
"paths": {
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/BatteryCapacity": {
"get": {
"description": "BatteryCapacity from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'BatteryCapacity'",
"tags": [
"EVSEServer"
]
},
"put": {
"description": "BatteryCapacity from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Update Attribute 'BatteryCapacity'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/BatteryLevel": {
"get": {
"description": "BatteryLevel from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 8-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'BatteryLevel'",
"tags": [
"EVSEServer"
]
},
"put": {
"description": "BatteryLevel from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 8-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Update Attribute 'BatteryLevel'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerAutoStart": {
"get": {
"description": "Indicates if Charger autostarts when EV detected., **Mandatory/Optional:** Mandatory, **Type:** Boolean",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerAutoStartEnabled'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerDeliveredSummation": {
"get": {
"description": "Overall Energy consumption of the charger since installation, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 48-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerDeliveredSummation'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerFault": {
"get": {
"description": "Enumeration indicating the type of fault detected in the charger., **Mandatory/Optional:** Mandatory, **Type:** 8-bit Enumeration",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerFault'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerIRMS": {
"get": {
"description": "Charging current., **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerIRMS'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerInstantaneousDemand": {
"get": {
"description": "Instantaneous Demand from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** 24-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerInstantaneousDemand'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerLevel": {
"get": {
"description": "Enumeration indicating the Level Charging Standard in use., **Mandatory/Optional:** Mandatory, **Type:** 8-bit Enumeration",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerLevel'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerLineFrequency": {
"get": {
"description": "Line AC Frequency., **Mandatory/Optional:** Mandatory, **Type:** Unsigned 16-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerLineFrequency'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerMaximumCurrent": {
"get": {
"description": "Holds the amps to report to the EV during an active charging Session. The actual current value set to the EV may be limited depending on the actual Charger Level, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 16-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerMaximumCurrent'",
"tags": [
"EVSEServer"
]
},
"put": {
"description": "Holds the amps to report to the EV during an active charging Session. The actual current value set to the EV may be limited depending on the actual Charger Level, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 16-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Update Attribute 'ChargerMaximumCurrent'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerMinimumCurrent": {
"get": {
"description": "Holds the amps to report to the EV in stand-by, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 16-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerMinimumCurrent'",
"tags": [
"EVSEServer"
]
},
"put": {
"description": "Holds the amps to report to the EV in stand-by, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 16-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Update Attribute 'ChargerMinimumCurrent'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerSessionActive": {
"get": {
"description": "Indicates that the charger is currently in an active charging session. When made reportable indicates the start and stop of a charging session., **Mandatory/Optional:** Mandatory, **Type:** Boolean",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerSessionActive'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerSessionDuration": {
"get": {
"description": "Duration in seconds of the curent/last changing session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerSessionDuration'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerSessionID": {
"get": {
"description": "Session ID counter autoincremented each time a session is successfully started, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerSessionID'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerSessionSummation": {
"get": {
"description": "Energy consumption from the current/last charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 48-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerSessionSummation'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerStatus": {
"get": {
"description": "Enumeration indicating the status of the charger., **Mandatory/Optional:** Mandatory, **Type:** 8-bit Enumeration\n- Not Plugged In: 0x00\n- Plugged Not Charging: 0x01\n- Plugged Started: 0x02\n- Charging: 0x03\n- In error: 0x04\n- Charge completed: 0x05\n- Diagnostics Phase 1: 0xF0\n- Diagnostics Phase 2: 0xF2",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerStatus'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ChargerVRMS": {
"get": {
"description": "Charging voltage. Zero when charging stopped., **Mandatory/Optional:** Mandatory, **Type:** Unsigned 16-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ChargerVRMS'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/ElectricRange": {
"get": {
"description": "ElectricRange from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'ElectricRange'",
"tags": [
"EVSEServer"
]
},
"put": {
"description": "ElectricRange from the current charging session, **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Update Attribute 'ElectricRange'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/attributes/PilotState": {
"get": {
"description": "Enumeration indicating the status of the PILOT signal., **Mandatory/Optional:** Mandatory, **Type:** 8-bit Enumeration",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Read Attribute 'PilotState'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/DisableAutoStartMode": {
"post": {
"description": "Disabled auto-start Mode in the charger. **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Method 'DisableAutoStartMode'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/EVSEEvent": {
"post": {
"description": "Event informing about a Charger status change. **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Parameters Data",
"in": "body",
"name": "Data",
"required": true,
"schema": {
"$ref": "#/definitions/EVSEEventDefinition"
}
},
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Event 'EVSEEvent' with info about the charging sessions",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/EnableAutoStartMode": {
"post": {
"description": "Enabled auto-start Mode in the charger. Charging will start automatically when EV detected **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Method 'EnableAutoStartMode'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/EnterDiagnostics": {
"post": {
"description": "Enter in diagnostics mode **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Parameters Data",
"in": "body",
"name": "Data",
"required": true,
"schema": {
"$ref": "#/definitions/EnterDiagnosticsDefinition"
}
},
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Method 'EnterDiagnostics'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/ExitDiagnostics": {
"post": {
"description": "Exits diagnostics mode and allows charger to operate. **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Method 'ExitDiagnostics'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/StartCharge": {
"post": {
"description": "Indicates the charger to initiate a charging session. **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Method 'StartCharge'",
"tags": [
"EVSEServer"
]
}
},
"/devices/{id}/comps/{compid}/procs/EVSEServer/methods/StopCharge": {
"post": {
"description": "Indicates the charger to stop a charging session. **Mandatory/Optional:** Optional",
"parameters": [
{
"description": "Unique identifier for the Device",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Unique identifier for the Device component",
"in": "path",
"name": "compid",
"required": true,
"type": "number"
}
],
"responses": {
"204": {
"description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain",
"schema": {
"$ref": "#/definitions/NoContentResponse"
}
},
"400": {
"description": "The server cannot or will not process the request due to something that is perceived to be a client error",
"schema": {
"$ref": "#/definitions/BadRequest"
}
},
"401": {
"description": "Authentication is required and has failed or has not yet been provided",
"schema": {
"$ref": "#/definitions/Unauthorized"
}
},
"403": {
"description": "The client does not have necessary permissions for the resource",
"schema": {
"$ref": "#/definitions/Forbidden"
}
},
"404": {
"description": "The requested resource could not be found but may be available again in the future",
"schema": {
"$ref": "#/definitions/NotFound"
}
},
"405": {
"description": "A request was made of a resource using a request method not supported by that resource",
"schema": {
"$ref": "#/definitions/MethodNotAllowed"
}
},
"408": {
"description": "The server timed out waiting for the request",
"schema": {
"$ref": "#/definitions/RequestTimeout"
}
}
},
"security": [
{
"OAuth2": []
}
],
"summary": "Method 'StopCharge'",
"tags": [
"EVSEServer"
]
}
}
},
"produces": [
"application/json"
],
"schemes": [
"https"
],
"securityDefinitions": {
"OAuth2": {
"flow": "password",
"scopes": {},
"tokenUrl": "https://api.smartenit.io/v2/oauth2/token",
"type": "oauth2"
}
},
"swagger": "2.0",
"tags": [
{
"name": "EVSEServer"
}
]
}
|
Page History
Overview
Content Tools