[e-mobility-charging-stations-simulator.git] / src / assets / json-schemas / ocpp / 2.0 / SetNetworkProfileRequest.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "urn:OCPP:Cp:2:2020:3:SetNetworkProfileRequest",
  "$comment": "OCPP 2.0.1 FINAL",
  "definitions": {
    "CustomDataType": {
      "description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
      "javaType": "CustomData",
      "type": "object",
      "properties": {
        "vendorId": {
          "type": "string",
          "maxLength": 255
        }
      },
      "required": ["vendorId"]
    },
    "APNAuthenticationEnumType": {
      "description": "APN. APN_ Authentication. APN_ Authentication_ Code\r\nurn:x-oca:ocpp:uid:1:568828\r\nAuthentication method.\r\n",
      "javaType": "APNAuthenticationEnum",
      "type": "string",
      "additionalProperties": false,
      "enum": ["CHAP", "NONE", "PAP", "AUTO"]
    },
    "OCPPInterfaceEnumType": {
      "description": "Applicable Network Interface.\r\n",
      "javaType": "OCPPInterfaceEnum",
      "type": "string",
      "additionalProperties": false,
      "enum": [
        "Wired0",
        "Wired1",
        "Wired2",
        "Wired3",
        "Wireless0",
        "Wireless1",
        "Wireless2",
        "Wireless3"
      ]
    },
    "OCPPTransportEnumType": {
      "description": "Communication_ Function. OCPP_ Transport. OCPP_ Transport_ Code\r\nurn:x-oca:ocpp:uid:1:569356\r\nDefines the transport protocol (e.g. SOAP or JSON). Note: SOAP is not supported in OCPP 2.0, but is supported by other versions of OCPP.\r\n",
      "javaType": "OCPPTransportEnum",
      "type": "string",
      "additionalProperties": false,
      "enum": ["JSON", "SOAP"]
    },
    "OCPPVersionEnumType": {
      "description": "Communication_ Function. OCPP_ Version. OCPP_ Version_ Code\r\nurn:x-oca:ocpp:uid:1:569355\r\nDefines the OCPP version used for this communication function.\r\n",
      "javaType": "OCPPVersionEnum",
      "type": "string",
      "additionalProperties": false,
      "enum": ["OCPP12", "OCPP15", "OCPP16", "OCPP20"]
    },
    "VPNEnumType": {
      "description": "VPN. Type. VPN_ Code\r\nurn:x-oca:ocpp:uid:1:569277\r\nType of VPN\r\n",
      "javaType": "VPNEnum",
      "type": "string",
      "additionalProperties": false,
      "enum": ["IKEv2", "IPSec", "L2TP", "PPTP"]
    },
    "APNType": {
      "description": "APN\r\nurn:x-oca:ocpp:uid:2:233134\r\nCollection of configuration data needed to make a data-connection over a cellular network.\r\n\r\nNOTE: When asking a GSM modem to dial in, it is possible to specify which mobile operator should be used. This can be done with the mobile country code (MCC) in combination with a mobile network code (MNC). Example: If your preferred network is Vodafone Netherlands, the MCC=204 and the MNC=04 which means the key PreferredNetwork = 20404 Some modems allows to specify a preferred network, which means, if this network is not available, a different network is used. If you specify UseOnlyPreferredNetwork and this network is not available, the modem will not dial in.\r\n",
      "javaType": "APN",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "apn": {
          "description": "APN. APN. URI\r\nurn:x-oca:ocpp:uid:1:568814\r\nThe Access Point Name as an URL.\r\n",
          "type": "string",
          "maxLength": 512
        },
        "apnUserName": {
          "description": "APN. APN. User_ Name\r\nurn:x-oca:ocpp:uid:1:568818\r\nAPN username.\r\n",
          "type": "string",
          "maxLength": 20
        },
        "apnPassword": {
          "description": "APN. APN. Password\r\nurn:x-oca:ocpp:uid:1:568819\r\nAPN Password.\r\n",
          "type": "string",
          "maxLength": 20
        },
        "simPin": {
          "description": "APN. SIMPIN. PIN_ Code\r\nurn:x-oca:ocpp:uid:1:568821\r\nSIM card pin code.\r\n",
          "type": "integer"
        },
        "preferredNetwork": {
          "description": "APN. Preferred_ Network. Mobile_ Network_ ID\r\nurn:x-oca:ocpp:uid:1:568822\r\nPreferred network, written as MCC and MNC concatenated. See note.\r\n",
          "type": "string",
          "maxLength": 6
        },
        "useOnlyPreferredNetwork": {
          "description": "APN. Use_ Only_ Preferred_ Network. Indicator\r\nurn:x-oca:ocpp:uid:1:568824\r\nDefault: false. Use only the preferred Network, do\r\nnot dial in when not available. See Note.\r\n",
          "type": "boolean",
          "default": false
        },
        "apnAuthentication": {
          "$ref": "#/definitions/APNAuthenticationEnumType"
        }
      },
      "required": ["apn", "apnAuthentication"]
    },
    "NetworkConnectionProfileType": {
      "description": "Communication_ Function\r\nurn:x-oca:ocpp:uid:2:233304\r\nThe NetworkConnectionProfile defines the functional and technical parameters of a communication link.\r\n",
      "javaType": "NetworkConnectionProfile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "apn": {
          "$ref": "#/definitions/APNType"
        },
        "ocppVersion": {
          "$ref": "#/definitions/OCPPVersionEnumType"
        },
        "ocppTransport": {
          "$ref": "#/definitions/OCPPTransportEnumType"
        },
        "ocppCsmsUrl": {
          "description": "Communication_ Function. OCPP_ Central_ System_ URL. URI\r\nurn:x-oca:ocpp:uid:1:569357\r\nURL of the CSMS(s) that this Charging Station  communicates with.\r\n",
          "type": "string",
          "maxLength": 512
        },
        "messageTimeout": {
          "description": "Duration in seconds before a message send by the Charging Station via this network connection times-out.\r\nThe best setting depends on the underlying network and response times of the CSMS.\r\nIf you are looking for a some guideline: use 30 seconds as a starting point.\r\n",
          "type": "integer"
        },
        "securityProfile": {
          "description": "This field specifies the security profile used when connecting to the CSMS with this NetworkConnectionProfile.\r\n",
          "type": "integer"
        },
        "ocppInterface": {
          "$ref": "#/definitions/OCPPInterfaceEnumType"
        },
        "vpn": {
          "$ref": "#/definitions/VPNType"
        }
      },
      "required": [
        "ocppVersion",
        "ocppTransport",
        "ocppCsmsUrl",
        "messageTimeout",
        "securityProfile",
        "ocppInterface"
      ]
    },
    "VPNType": {
      "description": "VPN\r\nurn:x-oca:ocpp:uid:2:233268\r\nVPN Configuration settings\r\n",
      "javaType": "VPN",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "customData": {
          "$ref": "#/definitions/CustomDataType"
        },
        "server": {
          "description": "VPN. Server. URI\r\nurn:x-oca:ocpp:uid:1:569272\r\nVPN Server Address\r\n",
          "type": "string",
          "maxLength": 512
        },
        "user": {
          "description": "VPN. User. User_ Name\r\nurn:x-oca:ocpp:uid:1:569273\r\nVPN User\r\n",
          "type": "string",
          "maxLength": 20
        },
        "group": {
          "description": "VPN. Group. Group_ Name\r\nurn:x-oca:ocpp:uid:1:569274\r\nVPN group.\r\n",
          "type": "string",
          "maxLength": 20
        },
        "password": {
          "description": "VPN. Password. Password\r\nurn:x-oca:ocpp:uid:1:569275\r\nVPN Password.\r\n",
          "type": "string",
          "maxLength": 20
        },
        "key": {
          "description": "VPN. Key. VPN_ Key\r\nurn:x-oca:ocpp:uid:1:569276\r\nVPN shared secret.\r\n",
          "type": "string",
          "maxLength": 255
        },
        "type": {
          "$ref": "#/definitions/VPNEnumType"
        }
      },
      "required": ["server", "user", "password", "key", "type"]
    }
  },
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "customData": {
      "$ref": "#/definitions/CustomDataType"
    },
    "configurationSlot": {
      "description": "Slot in which the configuration should be stored.\r\n",
      "type": "integer"
    },
    "connectionData": {
      "$ref": "#/definitions/NetworkConnectionProfileType"
    }
  },
  "required": ["configurationSlot", "connectionData"]
}
Commit	Line	Data
d270cc87	1	{
98fc1389	2	"$schema": "http://json-schema.org/draft-07/schema#",
d270cc87	3	"$id": "urn:OCPP:Cp:2:2020:3:SetNetworkProfileRequest",
98fc1389	4	"$comment": "OCPP 2.0.1 FINAL",
d270cc87 JB	5	"definitions": {
	6	"CustomDataType": {
	7	"description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
	8	"javaType": "CustomData",
	9	"type": "object",
	10	"properties": {
	11	"vendorId": {
	12	"type": "string",
	13	"maxLength": 255
	14	}
	15	},
	16	"required": ["vendorId"]
	17	},
	18	"APNAuthenticationEnumType": {
	19	"description": "APN. APN_ Authentication. APN_ Authentication_ Code\r\nurn:x-oca:ocpp:uid:1:568828\r\nAuthentication method.\r\n",
	20	"javaType": "APNAuthenticationEnum",
	21	"type": "string",
	22	"additionalProperties": false,
	23	"enum": ["CHAP", "NONE", "PAP", "AUTO"]
	24	},
	25	"OCPPInterfaceEnumType": {
	26	"description": "Applicable Network Interface.\r\n",
	27	"javaType": "OCPPInterfaceEnum",
	28	"type": "string",
	29	"additionalProperties": false,
	30	"enum": [
	31	"Wired0",
	32	"Wired1",
	33	"Wired2",
	34	"Wired3",
	35	"Wireless0",
	36	"Wireless1",
	37	"Wireless2",
	38	"Wireless3"
	39	]
	40	},
	41	"OCPPTransportEnumType": {
	42	"description": "Communication_ Function. OCPP_ Transport. OCPP_ Transport_ Code\r\nurn:x-oca:ocpp:uid:1:569356\r\nDefines the transport protocol (e.g. SOAP or JSON). Note: SOAP is not supported in OCPP 2.0, but is supported by other versions of OCPP.\r\n",
	43	"javaType": "OCPPTransportEnum",
	44	"type": "string",
	45	"additionalProperties": false,
	46	"enum": ["JSON", "SOAP"]
	47	},
	48	"OCPPVersionEnumType": {
	49	"description": "Communication_ Function. OCPP_ Version. OCPP_ Version_ Code\r\nurn:x-oca:ocpp:uid:1:569355\r\nDefines the OCPP version used for this communication function.\r\n",
	50	"javaType": "OCPPVersionEnum",
	51	"type": "string",
	52	"additionalProperties": false,
	53	"enum": ["OCPP12", "OCPP15", "OCPP16", "OCPP20"]
	54	},
	55	"VPNEnumType": {
	56	"description": "VPN. Type. VPN_ Code\r\nurn:x-oca:ocpp:uid:1:569277\r\nType of VPN\r\n",
	57	"javaType": "VPNEnum",
	58	"type": "string",
	59	"additionalProperties": false,
	60	"enum": ["IKEv2", "IPSec", "L2TP", "PPTP"]
	61	},
	62	"APNType": {
	63	"description": "APN\r\nurn:x-oca:ocpp:uid:2:233134\r\nCollection of configuration data needed to make a data-connection over a cellular network.\r\n\r\nNOTE: When asking a GSM modem to dial in, it is possible to specify which mobile operator should be used. This can be done with the mobile country code (MCC) in combination with a mobile network code (MNC). Example: If your preferred network is Vodafone Netherlands, the MCC=204 and the MNC=04 which means the key PreferredNetwork = 20404 Some modems allows to specify a preferred network, which means, if this network is not available, a different network is used. If you specify UseOnlyPreferredNetwork and this network is not available, the modem will not dial in.\r\n",
	64	"javaType": "APN",
	65	"type": "object",
	66	"additionalProperties": false,
	67	"properties": {
	68	"customData": {
69	"$ref": "#/definitions/CustomDataType"
70	},
71	"apn": {
72	"description": "APN. APN. URI\r\nurn:x-oca:ocpp:uid:1:568814\r\nThe Access Point Name as an URL.\r\n",
73	"type": "string",
74	"maxLength": 512
75	},
76	"apnUserName": {
77	"description": "APN. APN. User_ Name\r\nurn:x-oca:ocpp:uid:1:568818\r\nAPN username.\r\n",
78	"type": "string",
79	"maxLength": 20
80	},
81	"apnPassword": {
82	"description": "APN. APN. Password\r\nurn:x-oca:ocpp:uid:1:568819\r\nAPN Password.\r\n",
83	"type": "string",
84	"maxLength": 20
85	},
86	"simPin": {
87	"description": "APN. SIMPIN. PIN_ Code\r\nurn:x-oca:ocpp:uid:1:568821\r\nSIM card pin code.\r\n",
88	"type": "integer"
89	},
90	"preferredNetwork": {
91	"description": "APN. Preferred_ Network. Mobile_ Network_ ID\r\nurn:x-oca:ocpp:uid:1:568822\r\nPreferred network, written as MCC and MNC concatenated. See note.\r\n",
92	"type": "string",
93	"maxLength": 6
94	},
95	"useOnlyPreferredNetwork": {
96	"description": "APN. Use_ Only_ Preferred_ Network. Indicator\r\nurn:x-oca:ocpp:uid:1:568824\r\nDefault: false. Use only the preferred Network, do\r\nnot dial in when not available. See Note.\r\n",
97	"type": "boolean",
98	"default": false
99	},
100	"apnAuthentication": {
101	"$ref": "#/definitions/APNAuthenticationEnumType"
102	}
103	},
104	"required": ["apn", "apnAuthentication"]
105	},
106	"NetworkConnectionProfileType": {
107	"description": "Communication_ Function\r\nurn:x-oca:ocpp:uid:2:233304\r\nThe NetworkConnectionProfile defines the functional and technical parameters of a communication link.\r\n",
108	"javaType": "NetworkConnectionProfile",
109	"type": "object",
110	"additionalProperties": false,
111	"properties": {
112	"customData": {
113	"$ref": "#/definitions/CustomDataType"
114	},
115	"apn": {
116	"$ref": "#/definitions/APNType"
117	},
118	"ocppVersion": {
119	"$ref": "#/definitions/OCPPVersionEnumType"
120	},
121	"ocppTransport": {
122	"$ref": "#/definitions/OCPPTransportEnumType"
123	},
124	"ocppCsmsUrl": {
125	"description": "Communication_ Function. OCPP_ Central_ System_ URL. URI\r\nurn:x-oca:ocpp:uid:1:569357\r\nURL of the CSMS(s) that this Charging Station communicates with.\r\n",
126	"type": "string",
127	"maxLength": 512
128	},
129	"messageTimeout": {
130	"description": "Duration in seconds before a message send by the Charging Station via this network connection times-out.\r\nThe best setting depends on the underlying network and response times of the CSMS.\r\nIf you are looking for a some guideline: use 30 seconds as a starting point.\r\n",
131	"type": "integer"
132	},
133	"securityProfile": {
134	"description": "This field specifies the security profile used when connecting to the CSMS with this NetworkConnectionProfile.\r\n",
135	"type": "integer"
136	},
137	"ocppInterface": {
138	"$ref": "#/definitions/OCPPInterfaceEnumType"
139	},
140	"vpn": {
141	"$ref": "#/definitions/VPNType"
142	}
143	},
144	"required": [
145	"ocppVersion",
146	"ocppTransport",
147	"ocppCsmsUrl",
148	"messageTimeout",
149	"securityProfile",
150	"ocppInterface"
151	]
152	},
153	"VPNType": {
154	"description": "VPN\r\nurn:x-oca:ocpp:uid:2:233268\r\nVPN Configuration settings\r\n",
155	"javaType": "VPN",
156	"type": "object",
157	"additionalProperties": false,
158	"properties": {
159	"customData": {
160	"$ref": "#/definitions/CustomDataType"
161	},
162	"server": {
163	"description": "VPN. Server. URI\r\nurn:x-oca:ocpp:uid:1:569272\r\nVPN Server Address\r\n",
164	"type": "string",
165	"maxLength": 512
166	},
167	"user": {
168	"description": "VPN. User. User_ Name\r\nurn:x-oca:ocpp:uid:1:569273\r\nVPN User\r\n",
169	"type": "string",
170	"maxLength": 20
171	},
172	"group": {
173	"description": "VPN. Group. Group_ Name\r\nurn:x-oca:ocpp:uid:1:569274\r\nVPN group.\r\n",
174	"type": "string",
175	"maxLength": 20
176	},
177	"password": {
178	"description": "VPN. Password. Password\r\nurn:x-oca:ocpp:uid:1:569275\r\nVPN Password.\r\n",
179	"type": "string",
180	"maxLength": 20
181	},
182	"key": {
183	"description": "VPN. Key. VPN_ Key\r\nurn:x-oca:ocpp:uid:1:569276\r\nVPN shared secret.\r\n",
184	"type": "string",
185	"maxLength": 255
186	},
187	"type": {
188	"$ref": "#/definitions/VPNEnumType"
189	}
190	},
191	"required": ["server", "user", "password", "key", "type"]
192	}
193	},
194	"type": "object",
195	"additionalProperties": false,
196	"properties": {
197	"customData": {
198	"$ref": "#/definitions/CustomDataType"
199	},
200	"configurationSlot": {
201	"description": "Slot in which the configuration should be stored.\r\n",
202	"type": "integer"
203	},
204	"connectionData": {
205	"$ref": "#/definitions/NetworkConnectionProfileType"
206	}
207	},
208	"required": ["configurationSlot", "connectionData"]
209	}