Qodex.ai

Siemens Battery Passport API - Preliminary version from 06.02.2024

Number of APIs: 10

This API specification serves as reference within the Siemens Battery Passport Platform for how to design and specify HTTPs-based APIs.

  1. passports-public-{batterypassid} - Get battery passport public attributes by providing the batterypassid GET {{baseUrl}}/passports/public/:batterypassid

  2. passports-{batterypassid} - Get battery passport private attributes by providing the batterypassid GET {{baseUrl}}/passports/:batterypassid

  3. passports-{batterypassid} - Update public and private battery passport attributes by providing the batterypassid PATCH {{baseUrl}}/passports/:batterypassid

  4. passports-{batterypassid} - Delete battery passport by providing the batterypassid DELETE {{baseUrl}}/passports/:batterypassid

  5. passports - Get list of a user's private passes given a certain state GET {{baseUrl}}/passports?state=

  6. users - Get user by user name GET {{baseUrl}}/user/:username

  7. users - Add user POST {{baseUrl}}/user

  8. users - Update user PUT {{baseUrl}}/user

  9. passports-{batterypassid} - Restore PATCH {{baseUrl}}/passports/:batterypassid/restore

  10. passports - Create a new passport in its entirety POST {{baseUrl}}/passports