ocpp-messages/schema/v2.0/RequestStartTransactionRequest_v1p0.json

TypeScript definitions for Open Charge Point Protocol (OCPP)

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$id": "urn:OCPP:Cp:2:2018:4:RequestStartTransactionRequest",
  "comment": "OCPP 2.0 - v1p0",
  "definitions": {
    "ChargingProfileKindEnumType": {
      "type": "string",
      "additionalProperties": true,
      "enum": [
        "Absolute",
        "Recurring",
        "Relative"
      ]
    },
    "ChargingProfilePurposeEnumType": {
      "type": "string",
      "additionalProperties": true,
      "enum": [
        "ChargingStationExternalConstraints",
        "ChargingStationMaxProfile",
        "TxDefaultProfile",
        "TxProfile"
      ]
    },
    "ChargingRateUnitEnumType": {
      "type": "string",
      "additionalProperties": true,
      "enum": [
        "W",
        "A"
      ]
    },
    "IdTokenEnumType": {
      "type": "string",
      "additionalProperties": true,
      "enum": [
        "Central",
        "eMAID",
        "ISO14443",
        "KeyCode",
        "Local",
        "NoAuthorization",
        "ISO15693"
      ]
    },
    "RecurrencyKindEnumType": {
      "type": "string",
      "additionalProperties": true,
      "enum": [
        "Daily",
        "Weekly"
      ]
    },
    "AdditionalInfoType": {
      "javaType": "AdditionalInfo",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "additionalIdToken": {
          "type": "string",
          "maxLength": 36
        },
        "type": {
          "type": "string",
          "maxLength": 50
        }
      },
      "required": [
        "additionalIdToken",
        "type"
      ]
    },
    "ChargingProfileType": {
      "javaType": "ChargingProfile",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "type": "integer"
        },
        "stackLevel": {
          "type": "integer"
        },
        "primary": {
          "type": "boolean"
        },
        "chargingProfilePurpose": {
          "$ref": "#/definitions/ChargingProfilePurposeEnumType"
        },
        "chargingProfileKind": {
          "$ref": "#/definitions/ChargingProfileKindEnumType"
        },
        "recurrencyKind": {
          "$ref": "#/definitions/RecurrencyKindEnumType"
        },
        "validFrom": {
          "type": "string",
          "format": "date-time"
        },
        "validTo": {
          "type": "string",
          "format": "date-time"
        },
        "chargingSchedule": {
          "$ref": "#/definitions/ChargingScheduleType"
        },
        "transactionId": {
          "type": "string",
          "maxLength": 36
        }
      },
      "required": [
        "id",
        "stackLevel",
        "chargingProfilePurpose",
        "chargingProfileKind",
        "chargingSchedule"
      ]
    },
    "ChargingSchedulePeriodType": {
      "javaType": "ChargingSchedulePeriod",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "startPeriod": {
          "type": "integer"
        },
        "limit": {
          "type": "number"
        },
        "numberPhases": {
          "type": "integer"
        },
        "phaseToUse": {
          "type": "integer"
        }
      },
      "required": [
        "startPeriod",
        "limit"
      ]
    },
    "ChargingScheduleType": {
      "javaType": "ChargingSchedule",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "startSchedule": {
          "type": "string",
          "format": "date-time"
        },
        "duration": {
          "type": "integer"
        },
        "chargingRateUnit": {
          "$ref": "#/definitions/ChargingRateUnitEnumType"
        },
        "chargingSchedulePeriod": {
          "type": "array",
          "additionalItems": false,
          "items": {
            "$ref": "#/definitions/ChargingSchedulePeriodType"
          },
          "minItems": 1
        },
        "minChargingRate": {
          "type": "number"
        }
      },
      "required": [
        "chargingRateUnit",
        "chargingSchedulePeriod"
      ]
    },
    "IdTokenType": {
      "javaType": "IdToken",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "additionalInfo": {
          "type": "array",
          "additionalItems": false,
          "items": {
            "$ref": "#/definitions/AdditionalInfoType"
          },
          "minItems": 1
        },
        "idToken": {
          "type": "string",
          "maxLength": 36
        },
        "type": {
          "$ref": "#/definitions/IdTokenEnumType"
        }
      },
      "required": [
        "idToken",
        "type"
      ]
    }
  },
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "evseId": {
      "type": "integer"
    },
    "idToken": {
      "$ref": "#/definitions/IdTokenType"
    },
    "remoteStartId": {
      "type": "integer"
    },
    "chargingProfile": {
      "$ref": "#/definitions/ChargingProfileType"
    }
  },
  "required": [
    "remoteStartId",
    "idToken"
  ]
}