{ "openapi": "3.0.1", "info": { "title": "eMabler OCPI 2.2 API", "description": "This is the main API description of eMabler OCPI implementation", "termsOfService": "https://www.emabler.com/privacy-policy", "contact": { "name": "eMabler Ltd", "url": "https://www.emabler.com/contact", "email": "hello@emabler.com" }, "version": "1.0.1" }, "servers": [ { "url": "https://ocpi-linux-test.azurewebsites.net/ocpi" }, { "url": "https://ocpi.emabler.net/ocpi/", "description": "eMabler Testing Server" } ], "paths": { "/2.1.1/credentials": { "post": { "tags": [ "OCPI 2.1.1" ], "summary": "Initiates the registration process for this OCPI version.", "operationId": "PostCredentials211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token agreedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentials211OCPIResponse" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentials211OCPIResponse" } } } }, "405": { "description": " The client has already been registered before", "x-ms-summary": "Method not allowed" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/details": { "get": { "tags": [ "OCPI 2.1.1" ], "summary": "This is used to get info of which modules are implemented for a specific version of OCPI and what the endpoint URL is for this interface. Role not used.", "operationId": "GetVersionDetails211", "parameters": [ { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/versionDetailsOCPIResponse" } } } }, "401": { "description": " Header is missing or the credentials token doesn�t match any known party", "x-ms-summary": "Unauthorised" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/credentials": { "delete": { "tags": [ "OCPI 2.2.1" ], "summary": "Delete credentials", "description": "Delete credentials", "operationId": "DeleteCredentials221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "405": { "description": "Client has not been registered yet", "x-ms-summary": "Method not allowed" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "post": { "tags": [ "OCPI 2.2.1" ], "summary": "Initiates the registration process for this OCPI version.", "operationId": "PostCredentials221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "405": { "description": " The client has already been registered before", "x-ms-summary": "Method not allowed" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/credentials": { "delete": { "tags": [ "OCPI 2.2" ], "summary": "Delete credentials", "description": "Delete credentials", "operationId": "DeleteCredentials", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "405": { "description": "Client has not been registered yet", "x-ms-summary": "Method not allowed" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "post": { "tags": [ "OCPI 2.2" ], "summary": "Initiates the registration process for this OCPI version.", "operationId": "PostCredentials", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/credentialsOCPIResponse" } } } }, "405": { "description": " The client has already been registered before", "x-ms-summary": "Method not allowed" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/details": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "This is used to get info of which modules are implemented for a specific version of OCPI, which interface role is implemented, and what the endpoint URL is for this interface.", "operationId": "GetVersionDetails221", "parameters": [ { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/versionDetailsOCPIResponse" } } } }, "401": { "description": " Header is missing or the credentials token doesn't match any known party", "x-ms-summary": "Unauthorised" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/details": { "get": { "tags": [ "OCPI 2.2" ], "summary": "This is used to get info of which modules are implemented for a specific version of OCPI, which interface role is implemented, and what the endpoint URL is for this interface.", "operationId": "GetVersionDetails", "parameters": [ { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/versionDetailsOCPIResponse" } } } }, "401": { "description": " Header is missing or the credentials token doesn�t match any known party", "x-ms-summary": "Unauthorised" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/versions": { "get": { "tags": [ "OCPI" ], "summary": "Fetch all supported OCPI versions.", "operationId": "GetVersions", "parameters": [ { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/versionsOCPIResponse" } } } }, "401": { "description": " Header is missing or the credentials token doesn’t match any known party", "x-ms-summary": "Unauthorised" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/tokens/{country_code_id}/{party_id}/{token_uid}": { "patch": { "tags": [ "OCPI 2.1.1" ], "summary": "Updated Token objects are pushed from the eMSP to the CPO.", "operationId": "PatchTokens211", "parameters": [ { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to create or replace", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to create or replace. Default if omitted: RFID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token211" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } }, "security": [ { "Authorization": [ ] } ] }, "put": { "tags": [ "OCPI 2.1.1" ], "summary": "New or updated Token objects are pushed from the eMSP to the CPO.", "operationId": "PutTokens211", "parameters": [ { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to create or replace", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to create or replace. Default if omitted: RFID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token211" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "201": { "description": "The Created response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } }, "security": [ { "Authorization": [ ] } ] }, "get": { "tags": [ "OCPI 2.1.1" ], "summary": "To check the status of a Token in the CPO system.", "operationId": "GetTokens211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP requesting this GET", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP requesting this GET", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to retrieve. Default if omitted: RFID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/tokens/{country_code_id}/{party_id}/{token_uid}": { "patch": { "tags": [ "OCPI 2.2" ], "summary": "Updated Token objects are pushed from the eMSP to the CPO.", "operationId": "PatchTokens", "parameters": [ { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to create or replace", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to create or replace. Default if omitted: RFID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } }, "security": [ { "Authorization": [ ] } ] }, "get": { "tags": [ "OCPI 2.2" ], "summary": "To check the status of a Token in the CPO system.", "operationId": "GetTokens", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP requesting this GET", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP requesting this GET", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to retrieve. Default if omitted: RFID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "put": { "tags": [ "OCPI 2.2" ], "summary": "New or updated Token objects are pushed from the eMSP to the CPO.", "operationId": "PutTokens", "parameters": [ { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to create or replace", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to create or replace. Default if omitted: RFID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } }, "security": [ { "Authorization": [ ] } ] } }, "/2.2.1/tokens/{country_code_id}/{party_id}/{token_uid}": { "patch": { "tags": [ "OCPI 2.2.1" ], "summary": "Updated Token objects are pushed from the eMSP to the CPO.", "operationId": "PatchTokens221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to create or replace", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to create or replace. Default if omitted: RFID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "get": { "tags": [ "OCPI 2.2.1" ], "summary": "To check the status of a Token in the CPO system.", "operationId": "GetTokens221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "country_code_id", "in": "path", "description": "Country code of the eMSP requesting this GET", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP requesting this GET", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to retrieve. Default if omitted: RFID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "put": { "tags": [ "OCPI 2.2.1" ], "summary": "New or updated Token objects are pushed from the eMSP to the CPO.", "operationId": "PutTokens221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "country_code", "in": "path", "description": "Country code of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "party_id", "in": "path", "description": "Party ID (Provider ID) of the eMSP sending this PUT request", "required": true, "schema": { "type": "string" } }, { "name": "token_uid", "in": "path", "description": "Token.uid of the Token object to create or replace", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Token.type of the Token to create or replace. Default if omitted: RFID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/token" } } } }, "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/cdrs": { "get": { "tags": [ "OCPI 2.1.1" ], "summary": "Fetch CDRs from the CPO’s system.", "operationId": "GetCdrs211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cdrs211OCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/commands/{command}": { "post": { "tags": [ "OCPI 2.1.1" ], "summary": "Enables to send commands to a Location / EVSE", "operationId": "PostCommands211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "command", "in": "path", "description": "Type of command that is requested", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stopSessionRequest" } } } }, "responses": { "200": { "description": "CommandResponse", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/locations": { "get": { "tags": [ "OCPI 2.1.1" ], "summary": "This is used to retrieve information about a list of available Locations with EVSEs and Connectors.", "operationId": "GetLocationsList211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/locations/{location_id}/{evse_uid?}/{connector_id?}": { "get": { "tags": [ "OCPI 2.1.1" ], "summary": "This is used to retrieve information about one specific Location, EVSE or Connector.", "operationId": "GetLocationsObject211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "location_id", "in": "path", "description": "Location.id of the Location object to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "evse_uid", "in": "path", "description": "Evse.uid, required when requesting an EVSE or Connector object", "schema": { "type": "string" } }, { "name": "connector_id", "in": "path", "description": "Connector.id, required when requesting a Connector object", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/location" } } } }, "404": { "description": "No locations available", "x-ms-summary": "Not found" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/sessions": { "get": { "tags": [ "OCPI 2.1.1" ], "summary": "Fetch Sessions from the CPO’s system.", "operationId": "GetSessions", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sessions211OCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.1.1/cpo/tariffs": { "get": { "tags": [ "OCPI 2.1.1" ], "summary": "Fetch information about all Tariffs.", "operationId": "GetTariffs211", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token token", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return tariffs that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return tariffs that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/cdrs": { "get": { "tags": [ "OCPI 2.2" ], "summary": "Fetch CDRs from the CPO’s system.", "operationId": "GetCdrs", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cdrsOCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/cdrs": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "Fetch CDRs from the CPO's system.", "operationId": "GetCdrs221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cdrsOCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/chargingprofiles/{session_id}": { "delete": { "tags": [ "OCPI 2.2" ], "summary": "Clears the ChargingProfile set by the eMSP on the given session.", "operationId": "DeleteChargingProfiles", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "The unique id that identifies the session in the CPO platform", "required": true, "schema": { "type": "string" } }, { "name": "response_url", "in": "query", "description": "URL that the ActiveChargingProfileResult POST should be send to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "get": { "tags": [ "OCPI 2.2" ], "summary": "Gets the ActiveChargingProfile for a specific charging session.", "operationId": "GetChargingProfiles", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "The unique id that identifies the session in the CPO platform", "required": true, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "description": "Length of the requested ActiveChargingProfile in seconds Duration in seconds", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "response_url", "in": "query", "description": "URL that the ActiveChargingProfileResult POST should be send to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "put": { "tags": [ "OCPI 2.2" ], "summary": "Creates a new ChargingProfile on a session, or replaces an existing ChargingProfile on the EVSE.", "operationId": "PutChargingProfiles", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "The unique id that identifies the session in the CPO platform", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/chargingprofiles/{session_id}": { "delete": { "tags": [ "OCPI 2.2.1" ], "summary": "Clears the ChargingProfile set by the eMSP on the given session.", "operationId": "DeleteChargingProfiles221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "The unique id that identifies the session in the CPO platform", "required": true, "schema": { "type": "string" } }, { "name": "response_url", "in": "query", "description": "URL that the ActiveChargingProfileResult POST should be send to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "get": { "tags": [ "OCPI 2.2.1" ], "summary": "Gets the ActiveChargingProfile for a specific charging session.", "operationId": "GetChargingProfiles221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "The unique id that identifies the session in the CPO platform", "required": true, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "description": "Length of the requested ActiveChargingProfile in seconds Duration in seconds", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "response_url", "in": "query", "description": "URL that the ActiveChargingProfileResult POST should be send to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "put": { "tags": [ "OCPI 2.2.1" ], "summary": "Creates a new ChargingProfile on a session, or replaces an existing ChargingProfile on the EVSE.", "operationId": "PutChargingProfiles221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "The unique id that identifies the session in the CPO platform", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/chargingprofiles": { "post": { "tags": [ "OCPI 2.2" ], "summary": "Creates a new ChargingProfile on the EVSE(s), or replaces an existing ChargingProfile on the EVSE.", "operationId": "PostChargingProfiles", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/chargingprofiles": { "post": { "tags": [ "OCPI 2.2.1" ], "summary": "Creates a new ChargingProfile on the EVSE(s), or replaces an existing ChargingProfile on the EVSE.", "operationId": "PostChargingProfiles221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/commands/{command}": { "post": { "tags": [ "OCPI 2.2" ], "summary": "Enables to send commands to a Location / EVSE", "operationId": "PostCommands", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "command", "in": "path", "description": "Type of command that is requested", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/startSessionRequest" } } } }, "responses": { "200": { "description": "CommandResponse", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/commands/{command}": { "post": { "tags": [ "OCPI 2.2.1" ], "summary": "Enables to send commands to a Location / EVSE", "operationId": "PostCommands221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "command", "in": "path", "description": "Type of command that is requested", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/startSessionRequest" } } } }, "responses": { "200": { "description": "CommandResponse", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/locations": { "get": { "tags": [ "OCPI 2.2" ], "summary": "This is used to retrieve information about a list of available Locations with EVSEs and Connectors.", "operationId": "GetLocationsList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/locations": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "This is used to retrieve information about a list of available Locations with EVSEs and Connectors.", "operationId": "GetLocationsList221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/locations/{location_id}/{evse_uid?}/{connector_id?}": { "get": { "tags": [ "OCPI 2.2" ], "summary": "This is used to retrieve information about one specific Location, EVSE or Connector.", "operationId": "GetLocationsObject", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "location_id", "in": "path", "description": "Location.id of the Location object to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "evse_uid", "in": "path", "description": "Evse.uid, required when requesting an EVSE or Connector object", "schema": { "type": "string" } }, { "name": "connector_id", "in": "path", "description": "Connector.id, required when requesting a Connector object", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/location" } } } }, "404": { "description": "No locations available", "x-ms-summary": "Not found" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/locations/{location_id}/{evse_uid?}/{connector_id?}": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "This is used to retrieve information about one specific Location, EVSE or Connector.", "operationId": "GetLocationsObject221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "location_id", "in": "path", "description": "Location.id of the Location object to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "evse_uid", "in": "path", "description": "Evse.uid, required when requesting an EVSE or Connector object", "schema": { "type": "string" } }, { "name": "connector_id", "in": "path", "description": "Connector.id, required when requesting a Connector object", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/location" } } } }, "404": { "description": "No locations available", "x-ms-summary": "Not found" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/sessions": { "get": { "tags": [ "OCPI 2.2" ], "summary": "Fetch Sessions from the CPO’s system.", "operationId": "GetSessions", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sessionsOCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/sessions": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "Fetch Sessions from the CPO's system.", "operationId": "GetSessions221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sessionsOCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/sessions/{session_id}": { "put": { "tags": [ "OCPI 2.2" ], "summary": "Set/update the driver’s Charging Preferences for this charging session.", "operationId": "PutSessions", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "Session.id of the Session for which the Charging Preferences are to be set", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/sessions/{session_id}": { "put": { "tags": [ "OCPI 2.2.1" ], "summary": "Set/update the driver's Charging Preferences for this charging session.", "operationId": "PutSessions221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "session_id", "in": "path", "description": "Session.id of the Session for which the Charging Preferences are to be set", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2/tariffs": { "get": { "tags": [ "OCPI 2.2" ], "summary": "Fetch information about all Tariffs.", "operationId": "GetTariffs", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return tariffs that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return tariffs that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "headers": { "X-Limit": { "description": "The maximum number of objects that the server can return." }, "X-Total-Count": { "description": "The total number of objects available in the server system that match the given parameters." }, "Link": { "description": "Link to the next page if exists." } }, "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/tariffs": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "Fetch information about all Tariffs.", "operationId": "GetTariffs221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return tariffs that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return tariffs that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/payments/financial-advice-confirmations": { "post": { "tags": [ "OCPI 2.2.1" ], "summary": "Financial Advice Confirmation objects are pushed from the PTP to the eMabler.", "operationId": "PostFinancialAdviceConfirmation221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financialAdviceConfirmationRequest" } } } }, "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/payments/terminals/{terminal_id}": { "get": { "tags": [ "OCPI 2.2.1" ], "summary": "Fetch a specific Terminal from the CPO's system.", "operationId": "GetPaymentTerminal221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "terminal_id", "in": "path", "description": "Unique Terminal ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerminalOCPIResponse" } } } }, "404": { "description": "Payment terminal not found", "x-ms-summary": "Not found" }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } }, "/2.2.1/payments/terminals": { "post": { "tags": [ "OCPI 2.2.1" ], "summary": "New Terminal objects are pushed from the eMSP to the CPO.", "operationId": "PostPaymentTerminals221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerminalRequest" } } } }, "responses": { "200": { "description": "The OK response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } }, "get": { "tags": [ "OCPI 2.2.1" ], "summary": "Fetch Terminals from the CPO's system.", "operationId": "GetTPaymentTerminals221", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token Base64encodedtoken", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-ID", "in": "header", "description": "Unique request ID", "required": true, "schema": { "type": "string" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Unique correlation ID", "required": true, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Only return objects that have last_updated after or equal to this Date/Time (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "description": "Only return objects that have last_updated up to this Date/Time, but not including (exclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "The offset of the first object returned. Default is 0 (the first object).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects to GET.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The OK response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerminalOCPIResponse" } } } }, "400": { "description": "Something went wrong", "x-ms-summary": "Unexpected failure" } } } } }, "components": { "schemas": { "additionalGeoLocation": { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" }, "name": { "$ref": "#/components/schemas/displayText" } } }, "businessDetails": { "type": "object", "properties": { "name": { "type": "string" }, "website": { "type": "string", "format": "uri" }, "logo": { "$ref": "#/components/schemas/image" } } }, "cdrDimension": { "type": "object", "properties": { "type": { "enum": [ "CURRENT", "ENERGY", "ENERGY_EXPORT", "ENERGY_IMPORT", "MAX_CURRENT", "MIN_CURRENT", "MAX_POWER", "MIN_POWER", "PARKING_TIME", "POWER", "RESERVATION_TIME", "STATE_OF_CHARGE", "TIME", "FLAT" ], "type": "string", "default": "CURRENT" }, "volume": { "type": "number", "format": "float" } } }, "cdrLocation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parkingType": { "enum": [ "ALONG_MOTORWAY", "PARKING_GARAGE", "PARKING_LOT", "ON_DRIVEWAY", "ON_STREET", "UNDERGROUND_GARAGE", "OTHER", "UNKNOWN" ], "type": "string", "default": "ALONG_MOTORWAY", "nullable": true }, "address": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "coordinates": { "$ref": "#/components/schemas/geoLocation" }, "evseUid": { "type": "string" }, "evseId": { "type": "string" }, "connectorId": { "type": "string" }, "connectorStandard": { "type": "string" }, "connectorFormat": { "enum": [ "SOCKET", "CABLE" ], "type": "string", "default": "SOCKET", "nullable": true }, "connectorPowerType": { "enum": [ "AC_1_PHASE", "AC_2_PHASE", "AC_2_PHASE_SPLIT", "AC_3_PHASE", "DC" ], "type": "string", "default": "AC_1_PHASE", "nullable": true }, "locationLastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "chargerLastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "connectorLastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "cdrs211OCPIResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/chargeDetailRecord211" } }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "cdrsOCPIResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/chargeDetailRecord" } }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "cdrToken": { "type": "object", "properties": { "uid": { "type": "string" }, "type": { "enum": [ "AD_HOC_USER", "APP_USER", "OTHER", "RFID" ], "type": "string", "default": "AD_HOC_USER" }, "contractId": { "type": "string" }, "countryCode": { "type": "string" }, "partyId": { "type": "string" } } }, "chargeDetailRecord": { "type": "object", "properties": { "partyId": { "type": "string" }, "countryCode": { "type": "string" }, "id": { "type": "string" }, "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "endDateTime": { "type": "string", "format": "date-time", "nullable": true }, "sessionId": { "type": "string" }, "cdrToken": { "$ref": "#/components/schemas/cdrToken" }, "authMethod": { "enum": [ "AUTH_REQUEST", "COMMAND", "WHITELIST" ], "type": "string", "default": "AUTH_REQUEST", "nullable": true }, "authorizationReference": { "type": "string" }, "cdrLocation": { "$ref": "#/components/schemas/cdrLocation" }, "meterId": { "type": "string" }, "currency": { "type": "string" }, "tariffs": { "type": "array", "items": { "$ref": "#/components/schemas/tariff" } }, "chargingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/chargingPeriod" } }, "signedData": { "$ref": "#/components/schemas/signedData" }, "totalCost": { "$ref": "#/components/schemas/price" }, "totalFixedCost": { "$ref": "#/components/schemas/price" }, "totalEnergy": { "type": "number", "format": "double", "nullable": true }, "totalEnergyCost": { "$ref": "#/components/schemas/price" }, "totalTime": { "type": "number", "format": "double", "nullable": true }, "totalTimeCost": { "$ref": "#/components/schemas/price" }, "totalParkingTime": { "type": "number", "format": "double", "nullable": true }, "totalParkingCost": { "$ref": "#/components/schemas/price" }, "totalReservationCost": { "$ref": "#/components/schemas/price" }, "remark": { "type": "string" }, "invoiceReferenceId": { "type": "string" }, "credit": { "type": "boolean", "nullable": true }, "creditReferenceId": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "homeChargingCompensation": { "type": "boolean", "nullable": true } } }, "chargeDetailRecord211": { "type": "object", "properties": { "id": { "type": "string" }, "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "stopDateTime": { "type": "string", "format": "date-time", "nullable": true }, "authId": { "type": "string" }, "authMethod": { "enum": [ "AUTH_REQUEST", "COMMAND", "WHITELIST" ], "type": "string", "default": "AUTH_REQUEST", "nullable": true }, "location": { "$ref": "#/components/schemas/location211" }, "meterId": { "type": "string" }, "currency": { "type": "string" }, "tariffs": { "type": "array", "items": { "$ref": "#/components/schemas/tariff211" } }, "chargingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/chargingPeriod" } }, "totalCost": { "type": "number", "format": "double", "nullable": true }, "totalEnergy": { "type": "number", "format": "double", "nullable": true }, "totalTime": { "type": "number", "format": "double", "nullable": true }, "totalParkingTime": { "type": "number", "format": "double", "nullable": true }, "remark": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "chargingPeriod": { "type": "object", "properties": { "startDateTime": { "type": "string", "format": "date-time" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/cdrDimension" } }, "tariffId": { "type": "string" } } }, "connectorInfo": { "type": "object", "properties": { "id": { "type": "string" }, "standard": { "enum": [ "CHADEMO", "CHAOJI", "DOMESTIC_A", "DOMESTIC_B", "DOMESTIC_C", "DOMESTIC_D", "DOMESTIC_E", "DOMESTIC_F", "DOMESTIC_G", "DOMESTIC_H", "DOMESTIC_I", "DOMESTIC_J", "DOMESTIC_K", "DOMESTIC_L", "DOMESTIC_M", "DOMESTIC_N", "DOMESTIC_O", "GBT_AC", "GBT_DC", "IEC_60309_2_single_16", "IEC_60309_2_three_16", "IEC_60309_2_three_32", "IEC_60309_2_three_64", "IEC_62196_T1", "IEC_62196_T1_COMBO", "IEC_62196_T2", "IEC_62196_T2_COMBO", "IEC_62196_T3A", "IEC_62196_T3C", "NEMA_5_20", "NEMA_6_30", "NEMA_6_50", "NEMA_10_30", "NEMA_10_50", "NEMA_14_30", "NEMA_14_50", "PANTOGRAPH_BOTTOM_UP", "PANTOGRAPH_TOP_DOWN", "TESLA_R", "TESLA_S" ], "type": "string", "default": "CHADEMO", "nullable": true }, "format": { "enum": [ "SOCKET", "CABLE" ], "type": "string", "default": "SOCKET", "nullable": true }, "powerType": { "enum": [ "AC_1_PHASE", "AC_2_PHASE", "AC_2_PHASE_SPLIT", "AC_3_PHASE", "DC" ], "type": "string", "default": "AC_1_PHASE", "nullable": true }, "maxVoltage": { "type": "integer", "format": "int32", "nullable": true }, "maxAmperage": { "type": "integer", "format": "int32", "nullable": true }, "maxElectricPower": { "type": "integer", "format": "int32", "nullable": true }, "tariffIds": { "type": "array", "items": { "type": "string" } }, "termsAndConditions": { "type": "string", "format": "uri" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "connectorInfo211": { "type": "object", "properties": { "id": { "type": "string" }, "standard": { "enum": [ "CHADEMO", "CHAOJI", "DOMESTIC_A", "DOMESTIC_B", "DOMESTIC_C", "DOMESTIC_D", "DOMESTIC_E", "DOMESTIC_F", "DOMESTIC_G", "DOMESTIC_H", "DOMESTIC_I", "DOMESTIC_J", "DOMESTIC_K", "DOMESTIC_L", "DOMESTIC_M", "DOMESTIC_N", "DOMESTIC_O", "GBT_AC", "GBT_DC", "IEC_60309_2_single_16", "IEC_60309_2_three_16", "IEC_60309_2_three_32", "IEC_60309_2_three_64", "IEC_62196_T1", "IEC_62196_T1_COMBO", "IEC_62196_T2", "IEC_62196_T2_COMBO", "IEC_62196_T3A", "IEC_62196_T3C", "NEMA_5_20", "NEMA_6_30", "NEMA_6_50", "NEMA_10_30", "NEMA_10_50", "NEMA_14_30", "NEMA_14_50", "PANTOGRAPH_BOTTOM_UP", "PANTOGRAPH_TOP_DOWN", "TESLA_R", "TESLA_S" ], "type": "string", "default": "CHADEMO", "nullable": true }, "format": { "enum": [ "SOCKET", "CABLE" ], "type": "string", "default": "SOCKET", "nullable": true }, "powerType": { "enum": [ "AC_1_PHASE", "AC_2_PHASE", "AC_2_PHASE_SPLIT", "AC_3_PHASE", "DC" ], "type": "string", "default": "AC_1_PHASE", "nullable": true }, "voltage": { "type": "integer", "format": "int32", "nullable": true }, "amperage": { "type": "integer", "format": "int32", "nullable": true }, "tariffId": { "type": "string" }, "termsAndConditions": { "type": "string", "format": "uri" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "credentials": { "type": "object", "properties": { "token": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/credentialsRole" } } } }, "credentials211": { "type": "object", "properties": { "token": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "partyId": { "type": "string" }, "countryCode": { "type": "string" }, "businessDetails": { "$ref": "#/components/schemas/businessDetails" } } }, "credentials211OCPIResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/credentials211" }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "credentialsOCPIResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/credentials" }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "credentialsRole": { "type": "object", "properties": { "role": { "enum": [ "OpenData", "CPO", "EMSP", "HUB", "NAP", "NSP", "OTHER", "SCSP", "PTP", "UNDEFINED" ], "type": "string", "default": "OpenData" }, "party_id": { "type": "string" }, "country_code": { "type": "string" }, "business_details": { "$ref": "#/components/schemas/businessDetails" } } }, "displayText": { "type": "object", "properties": { "language": { "type": "string" }, "text": { "type": "string" } } }, "endpoint": { "type": "object", "properties": { "identifier": { "enum": [ "cdrs", "chargingprofiles", "commands", "credentials", "hubclientinfo", "locations", "sessions", "tariffs", "tariffslight", "tokens", "payments" ], "type": "string", "default": "cdrs" }, "role": { "enum": [ "SENDER", "RECEIVER", "BOTH" ], "type": "string", "default": "SENDER", "nullable": true }, "url": { "type": "string", "format": "uri" } } }, "energyContract": { "type": "object", "properties": { "supplierName": { "type": "string" }, "contractId": { "type": "string" } } }, "energyMix": { "type": "object", "properties": { "isGreenEnergy": { "type": "boolean" }, "energySources": { "type": "array", "items": { "$ref": "#/components/schemas/energySource" } }, "environImpact": { "type": "array", "items": { "$ref": "#/components/schemas/environmentalImpact" } }, "supplierName": { "type": "string" }, "energyProductName": { "type": "string" } } }, "energyMix211": { "type": "object", "properties": { "isGreenEnergy": { "type": "boolean" }, "energySources": { "type": "array", "items": { "$ref": "#/components/schemas/energySource" } }, "environImpact": { "type": "array", "items": { "$ref": "#/components/schemas/environmentalImpact211" } }, "supplierName": { "type": "string" }, "energyProductName": { "type": "string" } } }, "energySource": { "type": "object", "properties": { "source": { "enum": [ "NUCLEAR", "GENERAL_FOSSIL", "COAL", "GAS", "GENERAL_GREEN", "SOLAR", "WIND", "WATER" ], "type": "string", "default": "NUCLEAR" }, "percentage": { "type": "number", "format": "float" } } }, "environmentalImpact": { "type": "object", "properties": { "category": { "enum": [ "NUCLEAR_WASTE", "CARBON_DIOXIDE" ], "type": "string", "default": "NUCLEAR_WASTE" }, "amount": { "type": "number", "format": "float" } } }, "environmentalImpact211": { "type": "object", "properties": { "source": { "enum": [ "NUCLEAR_WASTE", "CARBON_DIOXIDE" ], "type": "string", "default": "NUCLEAR_WASTE" }, "amount": { "type": "number", "format": "float" } } }, "evseInfo": { "type": "object", "properties": { "uid": { "type": "string" }, "evseId": { "type": "string" }, "status": { "enum": [ "AVAILABLE", "BLOCKED", "CHARGING", "INOPERATIVE", "OUTOFORDER", "PLANNED", "REMOVED", "RESERVED", "UNKNOWN" ], "type": "string", "default": "AVAILABLE", "nullable": true }, "statusSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/evseStatusSchedule" } }, "capabilities": { "type": "array", "items": { "enum": [ "CHARGING_PROFILE_CAPABLE", "CHARGING_PREFERENCES_CAPABLE", "CHIP_CARD_SUPPORT", "CONTACTLESS_CARD_SUPPORT", "CREDIT_CARD_PAYABLE", "DEBIT_CARD_PAYABLE", "PED_TERMINAL", "REMOTE_START_STOP_CAPABLE", "RESERVABLE", "RFID_READER", "START_SESSION_CONNECTOR_REQUIRED", "TOKEN_GROUP_CAPABLE", "UNLOCK_CAPABLE" ], "type": "string", "default": "CHARGING_PROFILE_CAPABLE" } }, "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/connectorInfo" } }, "floorLevel": { "type": "string" }, "coordinates": { "$ref": "#/components/schemas/geoLocation" }, "physicalReference": { "type": "string" }, "directions": { "type": "array", "items": { "$ref": "#/components/schemas/displayText" } }, "parkingRestrictions": { "type": "array", "items": { "enum": [ "EV_ONLY", "PLUGGED", "DISABLED", "CUSTOMERS", "MOTORCYCLES" ], "type": "string", "default": "EV_ONLY" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/image" } }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "evseInfo211": { "type": "object", "properties": { "uid": { "type": "string" }, "evseId": { "type": "string" }, "status": { "enum": [ "AVAILABLE", "BLOCKED", "CHARGING", "INOPERATIVE", "OUTOFORDER", "PLANNED", "REMOVED", "RESERVED", "UNKNOWN" ], "type": "string", "default": "AVAILABLE", "nullable": true }, "statusSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/evseStatusSchedule" } }, "capabilities": { "type": "array", "items": { "enum": [ "CHARGING_PROFILE_CAPABLE", "CHARGING_PREFERENCES_CAPABLE", "CHIP_CARD_SUPPORT", "CONTACTLESS_CARD_SUPPORT", "CREDIT_CARD_PAYABLE", "DEBIT_CARD_PAYABLE", "PED_TERMINAL", "REMOTE_START_STOP_CAPABLE", "RESERVABLE", "RFID_READER", "START_SESSION_CONNECTOR_REQUIRED", "TOKEN_GROUP_CAPABLE", "UNLOCK_CAPABLE" ], "type": "string", "default": "CHARGING_PROFILE_CAPABLE" } }, "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/connectorInfo211" } }, "floorLevel": { "type": "string" }, "coordinates": { "$ref": "#/components/schemas/geoLocation" }, "physicalReference": { "type": "string" }, "directions": { "type": "array", "items": { "$ref": "#/components/schemas/displayText" } }, "parkingRestrictions": { "type": "array", "items": { "enum": [ "EV_ONLY", "PLUGGED", "DISABLED", "CUSTOMERS", "MOTORCYCLES" ], "type": "string", "default": "EV_ONLY" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/image" } }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "evseStatusSchedule": { "type": "object", "properties": { "period_begin": { "type": "string", "format": "date-time" }, "period_end": { "type": "string", "format": "date-time" }, "status": { "enum": [ "AVAILABLE", "BLOCKED", "CHARGING", "INOPERATIVE", "OUTOFORDER", "PLANNED", "REMOVED", "RESERVED", "UNKNOWN" ], "type": "string", "default": "AVAILABLE" } } }, "exceptionalPeriod": { "type": "object", "properties": { "periodBegin": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" } } }, "financialAdviceConfirmationRequest": { "type": "object", "properties": { "id": { "type": "string" }, "authorizationReference": { "type": "string" }, "totalCosts": { "$ref": "#/components/schemas/price" }, "currency": { "type": "string" }, "eftData": { "type": "array", "items": { "type": "string" } }, "captureStatusCode": { "type": "string" }, "captureStatusMessage": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "geoLocation": { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } } }, "hours": { "type": "object", "properties": { "twentyfourseven": { "type": "boolean" }, "regularHours": { "type": "array", "items": { "$ref": "#/components/schemas/regularHours" } }, "exceptionalOpenings": { "type": "array", "items": { "$ref": "#/components/schemas/exceptionalPeriod" } }, "exceptionalClosings": { "type": "array", "items": { "$ref": "#/components/schemas/exceptionalPeriod" } } } }, "image": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "thumbnail": { "type": "string", "format": "uri" }, "category": { "enum": [ "CHARGER", "ENTRANCE", "LOCATION", "NETWORK", "OPERATOR", "OTHER", "OWNER" ], "type": "string", "default": "CHARGER" }, "type": { "type": "string" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } } }, "location": { "type": "object", "properties": { "id": { "type": "string" }, "countryCode": { "type": "string" }, "partyId": { "type": "string" }, "publish": { "type": "boolean", "nullable": true }, "publishAllowedTo": { "type": "array", "items": { "$ref": "#/components/schemas/publishTokenType" } }, "name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "coordinates": { "$ref": "#/components/schemas/geoLocation" }, "relatedLocations": { "type": "array", "items": { "$ref": "#/components/schemas/additionalGeoLocation" } }, "parkingType": { "enum": [ "ALONG_MOTORWAY", "PARKING_GARAGE", "PARKING_LOT", "ON_DRIVEWAY", "ON_STREET", "UNDERGROUND_GARAGE", "OTHER", "UNKNOWN" ], "type": "string", "default": "ALONG_MOTORWAY", "nullable": true }, "evses": { "type": "array", "items": { "$ref": "#/components/schemas/evseInfo" } }, "directions": { "type": "array", "items": { "$ref": "#/components/schemas/displayText" } }, "operator": { "$ref": "#/components/schemas/businessDetails" }, "suboperator": { "$ref": "#/components/schemas/businessDetails" }, "owner": { "$ref": "#/components/schemas/businessDetails" }, "facilities": { "type": "array", "items": { "enum": [ "HOTEL", "RESTAURANT", "CAFE", "MALL", "SUPERMARKET", "SPORT", "RECREATION_AREA", "NATURE", "MUSEUM", "BIKE_SHARING", "BUS_STOP", "TAXI_STAND", "TRAM_STOP", "METRO_STATION", "TRAIN_STATION", "AIRPORT", "PARKING_LOT", "CARPOOL_PARKING", "FUEL_STATION", "WIFI" ], "type": "string", "default": "HOTEL" } }, "timeZone": { "type": "string" }, "openingTimes": { "$ref": "#/components/schemas/hours" }, "chargingWhenClosed": { "type": "boolean", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/image" } }, "energyMix": { "$ref": "#/components/schemas/energyMix" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "location211": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "ALONG_MOTORWAY", "PARKING_GARAGE", "PARKING_LOT", "ON_DRIVEWAY", "ON_STREET", "UNDERGROUND_GARAGE", "OTHER", "UNKNOWN" ], "type": "string", "default": "ALONG_MOTORWAY", "nullable": true }, "name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "coordinates": { "$ref": "#/components/schemas/geoLocation" }, "relatedLocations": { "type": "array", "items": { "$ref": "#/components/schemas/additionalGeoLocation" } }, "evses": { "type": "array", "items": { "$ref": "#/components/schemas/evseInfo211" } }, "directions": { "type": "array", "items": { "$ref": "#/components/schemas/displayText" } }, "operator": { "$ref": "#/components/schemas/businessDetails" }, "suboperator": { "$ref": "#/components/schemas/businessDetails" }, "owner": { "$ref": "#/components/schemas/businessDetails" }, "facilities": { "type": "array", "items": { "enum": [ "HOTEL", "RESTAURANT", "CAFE", "MALL", "SUPERMARKET", "SPORT", "RECREATION_AREA", "NATURE", "MUSEUM", "BIKE_SHARING", "BUS_STOP", "TAXI_STAND", "TRAM_STOP", "METRO_STATION", "TRAIN_STATION", "AIRPORT", "PARKING_LOT", "CARPOOL_PARKING", "FUEL_STATION", "WIFI" ], "type": "string", "default": "HOTEL" } }, "timeZone": { "type": "string" }, "openingTimes": { "$ref": "#/components/schemas/hours" }, "chargingWhenClosed": { "type": "boolean", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/image" } }, "energyMix": { "$ref": "#/components/schemas/energyMix211" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "paymentTerminal": { "type": "object", "properties": { "terminalId": { "type": "string" }, "customerReference": { "type": "string" }, "partyId": { "type": "string" }, "countryCode": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "coordinates": { "$ref": "#/components/schemas/geoLocation" }, "invoiceBaseUrl": { "type": "string", "format": "uri" }, "invoiceCreator": { "enum": [ "CPO", "PTP" ], "type": "string", "default": "CPO" }, "locationIds": { "type": "array", "items": { "type": "string" } }, "evseUids": { "type": "array", "items": { "type": "string" } }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "paymentTerminalOCPIResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/paymentTerminal" }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "paymentTerminalRequest": { "type": "object", "properties": { "terminalId": { "type": "string" }, "customerReference": { "type": "string" }, "partyId": { "type": "string" }, "countryCode": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "price": { "type": "object", "properties": { "exclVat": { "type": "number", "format": "float" }, "inclVat": { "type": "number", "format": "float", "nullable": true } } }, "priceComponent": { "type": "object", "properties": { "type": { "enum": [ "ENERGY", "FLAT", "PARKING_TIME", "TIME" ], "type": "string", "default": "ENERGY" }, "price": { "type": "number", "format": "float" }, "vat": { "type": "number", "format": "float", "nullable": true }, "stepSize": { "type": "integer", "format": "int32" } } }, "publishTokenType": { "type": "object", "properties": { "uid": { "type": "string" }, "type": { "enum": [ "AD_HOC_USER", "APP_USER", "OTHER", "RFID" ], "type": "string", "default": "AD_HOC_USER" }, "visualNumber": { "type": "string" }, "issuer": { "type": "string" }, "groupId": { "type": "string" } } }, "regularHours": { "type": "object", "properties": { "weekday": { "type": "integer", "format": "int32" }, "periodBegin": { "type": "string" }, "periodEnd": { "type": "string" } } }, "session": { "type": "object", "properties": { "countryCode": { "type": "string" }, "partyId": { "type": "string" }, "id": { "type": "string" }, "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "endDateTime": { "type": "string", "format": "date-time", "nullable": true }, "kwh": { "type": "number", "format": "float", "nullable": true }, "cdrToken": { "$ref": "#/components/schemas/cdrToken" }, "authMethod": { "enum": [ "AUTH_REQUEST", "COMMAND", "WHITELIST" ], "type": "string", "default": "AUTH_REQUEST", "nullable": true }, "authorizationReference": { "type": "string" }, "locationId": { "type": "string" }, "evseUid": { "type": "string" }, "connectorId": { "type": "string" }, "meterId": { "type": "string" }, "currency": { "type": "string" }, "chargingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/chargingPeriod" } }, "totalCost": { "$ref": "#/components/schemas/price" }, "status": { "enum": [ "ACTIVE", "COMPLETED", "INVALID", "PENDING", "RESERVATION" ], "type": "string", "default": "ACTIVE", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "session211": { "type": "object", "properties": { "id": { "type": "string" }, "startDatetime": { "type": "string", "format": "date-time", "nullable": true }, "endDatetime": { "type": "string", "format": "date-time", "nullable": true }, "kwh": { "type": "number", "format": "double", "nullable": true }, "authId": { "type": "string" }, "authMethod": { "enum": [ "AUTH_REQUEST", "COMMAND", "WHITELIST" ], "type": "string", "default": "AUTH_REQUEST", "nullable": true }, "location": { "$ref": "#/components/schemas/location211" }, "meterId": { "type": "string" }, "currency": { "type": "string" }, "chargingPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/chargingPeriod" } }, "totalCost": { "type": "number", "format": "double", "nullable": true }, "status": { "enum": [ "ACTIVE", "COMPLETED", "INVALID", "PENDING", "RESERVATION" ], "type": "string", "default": "ACTIVE", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "sessions211OCPIResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/session211" } }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "sessionsOCPIResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/session" } }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "signedData": { "type": "object", "properties": { "encodingMethod": { "type": "string" }, "encodingMethodVersion": { "type": "integer", "format": "int32", "nullable": true }, "publicKey": { "type": "string" }, "signedValues": { "type": "array", "items": { "$ref": "#/components/schemas/signedValue" } }, "url": { "type": "string", "format": "uri" } } }, "signedValue": { "type": "object", "properties": { "nature": { "type": "string" }, "plainData": { "type": "string" }, "signedData": { "type": "string" } } }, "startSessionRequest": { "type": "object", "properties": { "responseUrl": { "type": "string", "format": "uri" }, "token": { "$ref": "#/components/schemas/token" }, "locationId": { "type": "string" }, "evseUid": { "type": "string" }, "authorizationReference": { "type": "string" }, "connectorId": { "type": "string" } } }, "stopSessionRequest": { "type": "object", "properties": { "responseUrl": { "type": "string", "format": "uri" }, "sessionId": { "type": "string" } } }, "tariff": { "type": "object", "properties": { "id": { "type": "string" }, "countryCode": { "type": "string" }, "partyId": { "type": "string" }, "currency": { "type": "string" }, "type": { "enum": [ "AD_HOC_PAYMENT", "PROFILE_CHEAP", "PROFILE_FAST", "PROFILE_GREEN", "REGULAR" ], "type": "string", "default": "AD_HOC_PAYMENT", "nullable": true }, "tariffAltText": { "type": "array", "items": { "$ref": "#/components/schemas/displayText" } }, "tariffAltUrl": { "type": "string", "format": "uri" }, "minPrice": { "$ref": "#/components/schemas/price" }, "maxPrice": { "$ref": "#/components/schemas/price" }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/tariffElement" } }, "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "endDateTime": { "type": "string", "format": "date-time", "nullable": true }, "energyMix": { "$ref": "#/components/schemas/energyMix" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "tariff211": { "type": "object", "properties": { "id": { "type": "string" }, "currency": { "type": "string" }, "tariffAltText": { "type": "array", "items": { "$ref": "#/components/schemas/displayText" } }, "tariffAltUrl": { "type": "string", "format": "uri" }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/tariffElement" } }, "startDatetime": { "type": "string", "format": "date-time", "nullable": true }, "endDatetime": { "type": "string", "format": "date-time", "nullable": true }, "energyMix": { "$ref": "#/components/schemas/energyMix211" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "tariffElement": { "type": "object", "properties": { "priceComponents": { "type": "array", "items": { "$ref": "#/components/schemas/priceComponent" } }, "restrictions": { "$ref": "#/components/schemas/tariffRestrictions" } } }, "tariffRestrictions": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "minKwh": { "type": "number", "format": "double", "nullable": true }, "maxKwh": { "type": "number", "format": "double", "nullable": true }, "minCurrent": { "type": "number", "format": "double", "nullable": true }, "maxCurrent": { "type": "number", "format": "double", "nullable": true }, "minPower": { "type": "number", "format": "double", "nullable": true }, "maxPower": { "type": "number", "format": "double", "nullable": true }, "minDuration": { "type": "integer", "format": "int32", "nullable": true }, "maxDuration": { "type": "integer", "format": "int32", "nullable": true }, "dayOfWeek": { "type": "array", "items": { "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "type": "string", "default": "MONDAY" } }, "reservation": { "enum": [ "RESERVATION", "RESERVATION_EXPIRES" ], "type": "string", "default": "RESERVATION", "nullable": true } } }, "token": { "type": "object", "properties": { "partyId": { "type": "string" }, "countryCode": { "type": "string" }, "uid": { "type": "string" }, "type": { "enum": [ "AD_HOC_USER", "APP_USER", "OTHER", "RFID" ], "type": "string", "default": "AD_HOC_USER" }, "contractId": { "type": "string" }, "visualNumber": { "type": "string" }, "issuer": { "type": "string" }, "groupId": { "type": "string" }, "valid": { "type": "boolean" }, "whitelist": { "enum": [ "ALWAYS", "ALLOWED", "ALLOWED_OFFLINE", "NEVER" ], "type": "string", "default": "ALWAYS" }, "language": { "type": "string" }, "defaultProfileType": { "enum": [ "CHEAP", "FAST", "GREEN", "REGULAR" ], "type": "string", "default": "CHEAP", "nullable": true }, "energyContract": { "$ref": "#/components/schemas/energyContract" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "token211": { "type": "object", "properties": { "uid": { "type": "string" }, "type": { "enum": [ "AD_HOC_USER", "APP_USER", "OTHER", "RFID" ], "type": "string", "default": "AD_HOC_USER" }, "authId": { "type": "string" }, "visualNumber": { "type": "string" }, "issuer": { "type": "string" }, "valid": { "type": "boolean" }, "whitelist": { "enum": [ "ALWAYS", "ALLOWED", "ALLOWED_OFFLINE", "NEVER" ], "type": "string", "default": "ALWAYS" }, "language": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } } }, "versionDetails": { "type": "object", "properties": { "version": { "type": "string" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/endpoint" } } } }, "versionDetailsOCPIResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/versionDetails" }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "versionInfo": { "type": "object", "properties": { "version": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "versionsOCPIResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/versionInfo" } }, "statusCode": { "type": "integer", "format": "int32" }, "statusMessage": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } }, "securitySchemes": { "Authorization": { "type": "apiKey", "name": "Authorization", "in": "header" } } } }