chargerdojo_describe_access
What this server offers
Explain what this server can do, which tools are open to anyone, which need your ChargerDojo account, and each plan with its price and what it unlocks. Answers: what can I do here, what does my plan include, and how do I connect my account.
無需輸入參數。
chargerdojo_list_ocpi_versions
OCPI versions
List the OCPI versions ChargerDojo covers, with what each one is for and which modules are implemented. Answers: which OCPI versions can I test against.
無需輸入參數。
chargerdojo_get_ocpi_version
One OCPI version
Describe one OCPI version: how the credentials token is encoded, whether endpoints split into sender and receiver, which modules are implemented, and what the known limits are. Answers: how does this OCPI version work on the wire.
輸入參數version必填
chargerdojo_compare_ocpi_versions
Compare two OCPI versions
Compare two OCPI versions: what changed in the protocol between them, and which modules ChargerDojo gained. Answers: what changes when I move from one OCPI version to another.
輸入參數to必填from必填
chargerdojo_list_journey_templates
Charging journeys
List the OCPI charging journeys, each with the role it tests, its OCPI versions, the modules the endpoint must offer, the plan it needs against your own endpoint, and how long it runs on the sandbox. Filter by version and role. Answers: which journeys test my role at my OCPI version.
輸入參數roleversion
chargerdojo_get_usage
Plan and usage
Report the plan on this account and how much of each ceiling is left: targets, API keys, runs in flight, run rate and report retention. Answers: which plan am I on, and how close am I to its limits.
無需輸入參數。
chargerdojo_list_targets
Endpoints on this account
List the OCPI endpoints registered on this account, 25 a page, with each one's OCPI version, roles and registration status, or read one by id. Answers: which endpoints can I run against.
輸入參數cursortargetId
chargerdojo_list_runs
Recent runs
List the conformance runs and charging journeys on this account, newest first and 25 a page, with their status and pass and fail counts, narrowed by target, status or OCPI version. Answers: what ran recently, and how did it go.
輸入參數cursorstatusversiontargetId
chargerdojo_list_conformance_suites
Conformance suites
List the OCPI conformance suites that can be run, grouped by version and module, with how many checks each carries. Answers: what does a conformance run check at my OCPI version.
輸入參數version
chargerdojo_get_run_verdict
Run verdict
Read the verdict of one conformance run or charging journey on this account: how many checks passed, failed and warned, and whether anything graded at all. Answers: did this run pass.
輸入參數reportId必填
chargerdojo_list_checks
Checks for one module
List the checks a conformance run of one OCPI module grades at one version: each check id, what it sends, each rule as required or optional with its strength, and the clause of the OCPI spec each rule is graded against, quoted. Answers: what will ChargerDojo hold my module to, and where does the spec say so.
輸入參數aftermodule必填version必填
chargerdojo_validate_payload
Validate an OCPI object
Check one OCPI object, sent as JSON text, against the schema ChargerDojo grades that object with at one OCPI version, and list each field that breaks it. The JSON leaves your machine and is sent to chargerdojo.com; it is not stored or logged. Up to 64 KB, 30 calls a minute. Answers: is this a valid OCPI object at my version.
輸入參數json必填object必填version必填
chargerdojo_get_run_checks
Failed checks and their clauses
Read the checks of one conformance run on this account that failed, could not be graded or carried a warning, each with the rule it broke and the clause of the OCPI spec it was graded against, quoted. Answers: why did this run fail, and what does the spec say.
輸入參數afteroutcomereportId必填
chargerdojo_compare_run
What changed since the last run
Compare one conformance run with the previous comparable run against the same endpoint, OCPI version and module: which checks newly fail, which recovered, and which stopped being graded. Answers: what changed since my last run.
輸入參數reportId必填
chargerdojo_get_schedule
Schedule for one endpoint
Read the recurring run set on one target: its cadence, whether it is on or paused and why, when it runs next, and what its last run found. Schedules are set in the app, on the Automate plan. Answers: is my endpoint tested on a schedule, and did its last run pass.
輸入參數targetId必填
chargerdojo_get_journey_events
Journey events
Read what happened during a charging journey on this account, step by step, with which assertions passed at each step. Answers: what happened at each step of this journey.
輸入參數afterreportId必填
chargerdojo_cancel_run
Cancel a journey
Stop a charging journey that is still running on this account. It stops at the next safe point and keeps whatever it already graded. Answers: how do I stop a journey that is still running.
輸入參數reportId必填
chargerdojo_list_runnable_journeys
Journeys for one endpoint
List the charging journeys that can run against one target on this account, say why the target supports them, and name the plan any of them needs that this account does not have. Answers: which journeys fit this endpoint, by its role and version.
輸入參數targetId必填
chargerdojo_run_sandbox_journey
Run a sandbox journey
Run an OCPI charging journey against a sandbox endpoint. Answers: how do I try a journey without an endpoint of my own.
輸入參數retryKeytemplateId
chargerdojo_run_journey
Run a journey on an endpoint
Run an OCPI charging journey against an endpoint registered on this account, the sandbox or your own, and return its report id. Against your own endpoint it needs the Integrate plan, and a few journeys need a higher one, which chargerdojo_list_journey_templates names. Answers: does my endpoint pass this journey.
輸入參數retryKeytargetId必填templateId
chargerdojo_start_conformance_run
Start a conformance run
Start a conformance run against an endpoint registered on this account, the sandbox or your own: one module, or every module the endpoint offers. Returns the report id at once. Against your own endpoint it needs the Integrate plan, and a module sold on a higher plan names it. Answers: does my endpoint conform to OCPI.
輸入參數moduleretryKeytargetId必填
chargerdojo_send_feedback
Send feedback
Send a message to the people who build ChargerDojo: something missing, a bug, a question, or a verdict the person believes is wrong. Returns a reference.
輸入參數kind必填toolcheckIdmessage必填reportId