Skip to content
SPORTident Documentation

SIAC Battery Check API

Specification

Base URL:
https://api.sportident.com

Request:
GET /api/rest/v1/products/si-cards/{cardNumber}

Path parameters:

  • cardNumber: SIAC number (valid range: 8000001 to 8999999)

Response payload:

{
  "cardNumber": string,
  "batteryDate": string | null,
  "replaceBefore": string | null
}

Response fields:

  • cardNumber: SIAC number
  • batteryDate: Battery date (“YYYY-MM-DD”), null if battery date is unknown
  • replaceBefore: Recommended replacement date (“YYYY-MM-DD”), null if battery date is unknown

For ease-of-use, the API currently does not have any access restrictions. Such restrictions may be added in the future. Please send the following HTTP header with your GET requests to not be affected by potential future restrictions:

X-Sportident-Client-Id: (your secret client id)

Please conntact support@sportident.com to request a SPORTident client id.

Example for a successful request (HTTP status 200)

Request:
GET https://api.sportident.com/api/rest/v1/products/si-cards/8621484

Response:

{
  "cardNumber": "8621484",
  "batteryDate": "2020-01-15",
  "replaceBefore": "2023-01-15"
}

Error messages

Card not found (HTTP status 404)

Response payload:

{
  "title": "SI-Card not found.",
  "status": 404
}

Card number out of range (HTTP status 400)

Response payload:

{
  "errors": {
    "cardNumber": [
      "The value '{cardNumber}' is out of range. Only SI-Cards of type SIAC can be queried with this API."
    ]
  },
  "title": "One or more validation errors occurred.",
  "status": 400
}

Card number invalid (HTTP status 400)

Response payload:

{
  "errors": {
    "cardNumber": ["The value '{cardNumber}' is not valid."]
  },
  "title": "One or more validation errors occurred.",
  "status": 400
}

Notes

  • The data model might be extended with additional fields later on. Such extensions are considered compatible with v1 of the specifications. Consumers of the API should be able to deal with them accordingly, e.g. by ignoring any additional fields.
  • The content of error messages might change. Consumers of the API should not rely on the content of error messages, only on the HTTP status code.