RUFUS Help

Modelo de esquema

El sobreCualquier objeto

Definición del objeto EnvelopeAny.

Campo	Tipo	Obligatorio	Descripción
`body`	any	Opcional	Operation result body.

Ejemplo JSON

{
  "body": "string"
}

Modelo de esquema

El objeto EnvelopeNull

Definición del objeto EnvelopeNull.

Campo	Tipo	Obligatorio	Descripción
`body`	any \| null	Obligatorio	—

Ejemplo JSON

{
  "body": "string"
}

Modelo de esquema

El objeto de paginación

Definición del objeto Pagination.

Campo	Tipo	Obligatorio	Descripción
`page`	integer	Obligatorio	—
`limit`	integer	Obligatorio	—
`total`	integer	Obligatorio	—
`has_more`	boolean	Obligatorio	—

Ejemplo JSON

{
  "page": 1,
  "limit": 1,
  "total": 1,
  "has_more": true
}

Modelo de esquema

El objeto DeviceSummary

Definición del objeto DeviceSummary.

Campo	Tipo	Obligatorio	Descripción
`deviceid`	string	Obligatorio	—
`type`	string	Obligatorio	—
`model`	string	Obligatorio	—
`alias`	string	Obligatorio	—
`firmware`	string \| null	Opcional	—
`serial_number`	string	Obligatorio	—
`last_login`	string<date-time> \| null	Opcional	—
`creation_date`	string<date-time> \| null	Opcional	—
`sessions`	integer	Opcional	—
`device_status`	string \| null	Opcional	—
`battery_percentage`	integer \| null	Opcional	—
`charging`	boolean \| null	Opcional	—
`last_telemetry_at`	string<date-time> \| null	Opcional	—
`last_reported_latitude`	number \| null	Opcional	—
`last_reported_longitude`	number \| null	Opcional	—

Ejemplo JSON

{
  "deviceid": "DEVICE_ID",
  "type": "string",
  "model": "string",
  "alias": "string",
  "firmware": "string",
  "serial_number": "string",
  "last_login": "2026-09-02T10:30:00.000Z",
  "creation_date": "2026-09-02T10:30:00.000Z",
  "sessions": 1,
  "device_status": "string",
  "battery_percentage": 1,
  "charging": true,
  "last_telemetry_at": "2026-09-02T10:30:00.000Z",
  "last_reported_latitude": 1,
  "last_reported_longitude": 1
}

Modelo de esquema

El objeto DeviceDetails

Definición del objeto DeviceDetails.

Este esquema no define propiedades con nombre.

Ejemplo JSON

{
  "deviceid": "DEVICE_ID",
  "type": "string",
  "model": "string",
  "alias": "string",
  "firmware": "string",
  "serial_number": "string",
  "last_login": "2026-09-02T10:30:00.000Z",
  "creation_date": "2026-09-02T10:30:00.000Z",
  "sessions": 1,
  "device_status": "string",
  "battery_percentage": 1,
  "charging": true,
  "last_telemetry_at": "2026-09-02T10:30:00.000Z",
  "last_reported_latitude": 1,
  "last_reported_longitude": 1,
  "passings": 1,
  "last_seen": "2026-09-02T10:30:00.000Z",
  "battery_volts": 1,
  "temperature_celsius": 1,
  "gps_accuracy_m": 1,
  "network_type": "string",
  "signal_strength": 1
}

Modelo de esquema

El objeto BindDeviceRequest

Definición del objeto BindDeviceRequest.

Campo	Tipo	Obligatorio	Descripción
`type`	string	Obligatorio	—
`model`	string	Obligatorio	—
`serial_number`	string	Obligatorio	—
`alias`	string	Opcional	—
`firmware`	string	Opcional	—

Ejemplo JSON

{
  "type": "string",
  "model": "string",
  "serial_number": "string",
  "alias": "string",
  "firmware": "string"
}

Modelo de esquema

El objeto BindDeviceResponse

Definición del objeto BindDeviceResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "deviceid": "DEVICE_ID",
    "already_binded": true
  }
}

Modelo de esquema

El objeto UnbindDeviceResponse

Definición del objeto UnbindDeviceResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "deviceid": "DEVICE_ID"
  }
}

Modelo de esquema

El objeto DevicesListResponse

Definición del objeto DevicesListResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": [
      {
        "deviceid": "DEVICE_ID",
        "type": "string",
        "model": "string",
        "alias": "string",
        "firmware": "string",
        "serial_number": "string",
        "last_login": "2026-09-02T10:30:00.000Z",
        "creation_date": "2026-09-02T10:30:00.000Z",
        "sessions": 1,
        "device_status": "string",
        "battery_percentage": 1,
        "charging": true,
        "last_telemetry_at": "2026-09-02T10:30:00.000Z",
        "last_reported_latitude": 1,
        "last_reported_longitude": 1
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 1,
      "has_more": true
    }
  }
}

Modelo de esquema

El objeto DeviceGetResponse

Definición del objeto DeviceGetResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": {
      "deviceid": "DEVICE_ID",
      "type": "string",
      "model": "string",
      "alias": "string",
      "firmware": "string",
      "serial_number": "string",
      "last_login": "2026-09-02T10:30:00.000Z",
      "creation_date": "2026-09-02T10:30:00.000Z",
      "sessions": 1,
      "device_status": "string",
      "battery_percentage": 1,
      "charging": true,
      "last_telemetry_at": "2026-09-02T10:30:00.000Z",
      "last_reported_latitude": 1,
      "last_reported_longitude": 1,
      "passings": 1,
      "last_seen": "2026-09-02T10:30:00.000Z",
      "battery_volts": 1,
      "temperature_celsius": 1,
      "gps_accuracy_m": 1,
      "network_type": "string",
      "signal_strength": 1
    }
  }
}

Modelo de esquema

El objeto DeviceTelemetryRequest

At least one telemetry field is required.

Campo	Tipo	Obligatorio	Descripción
`reported_at`	string<date-time>	Opcional	—
`device_status`	string	Opcional	—
`battery_percentage`	integer	Opcional	—
`battery_volts`	number	Opcional	—
`charging`	boolean	Opcional	—
`temperature_celsius`	integer	Opcional	—
`latitude`	number	Opcional	—
`longitude`	number	Opcional	—
`gps_accuracy_m`	number	Opcional	—
`network_type`	string	Opcional	—
`signal_strength`	integer	Opcional	—

Ejemplo JSON

{
  "reported_at": "2026-09-02T10:30:00.000Z",
  "device_status": "string",
  "battery_percentage": 1,
  "battery_volts": 1,
  "charging": true,
  "temperature_celsius": 1,
  "latitude": 1,
  "longitude": 1,
  "gps_accuracy_m": 1,
  "network_type": "string",
  "signal_strength": 1
}

Modelo de esquema

El objeto DeviceTelemetryResponse

Definición del objeto DeviceTelemetryResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "deviceid": "DEVICE_ID",
    "result": {
      "deviceid": "DEVICE_ID",
      "last_telemetry_at": "2026-09-02T10:30:00.000Z",
      "device_status": "string",
      "battery_percentage": 1,
      "battery_volts": 1,
      "charging": true,
      "temperature_celsius": 1,
      "last_reported_latitude": 1,
      "last_reported_longitude": 1,
      "gps_accuracy_m": 1,
      "network_type": "string",
      "signal_strength": 1
    }
  }
}

Modelo de esquema

El objeto CreateSessionRequest

Definición del objeto CreateSessionRequest.

Campo	Tipo	Obligatorio	Descripción
`deviceid`	string	Obligatorio	—
`alias`	string	Opcional	—

Ejemplo JSON

{
  "deviceid": "DEVICE_ID",
  "alias": "string"
}

Modelo de esquema

El objeto CreateSessionResponse

Definición del objeto CreateSessionResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "token_session": "SESSION_TOKEN"
  }
}

Modelo de esquema

El objeto CloseSessionResponse

Definición del objeto CloseSessionResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "token_session": "SESSION_TOKEN"
  }
}

Modelo de esquema

El objeto SessionDetails

Definición del objeto SessionDetails.

Campo	Tipo	Obligatorio	Descripción
`token_session`	string	Obligatorio	—
`alias`	string	Obligatorio	—
`creation_date`	string<date-time>	Opcional	—
`duration`	number \| null	Opcional	—
`active`	boolean	Obligatorio	—
`passings`	integer	Opcional	—
`first`	string<date-time> \| null	Opcional	—
`last`	string<date-time> \| null	Opcional	—

Ejemplo JSON

{
  "token_session": "SESSION_TOKEN",
  "alias": "string",
  "creation_date": "2026-09-02T10:30:00.000Z",
  "duration": 1,
  "active": true,
  "passings": 1,
  "first": "2026-09-02T10:30:00.000Z",
  "last": "2026-09-02T10:30:00.000Z"
}

Modelo de esquema

El objeto SessionSummary

Definición del objeto SessionSummary.

Campo	Tipo	Obligatorio	Descripción
`token_session`	string	Obligatorio	—
`alias`	string	Obligatorio	—
`creation_date`	string<date-time>	Opcional	—
`duration`	number \| null	Opcional	—
`active`	boolean	Obligatorio	—
`passings`	integer	Opcional	—

Ejemplo JSON

{
  "token_session": "SESSION_TOKEN",
  "alias": "string",
  "creation_date": "2026-09-02T10:30:00.000Z",
  "duration": 1,
  "active": true,
  "passings": 1
}

Modelo de esquema

El objeto SessionGetResponse

Definición del objeto SessionGetResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": [
      {
        "token_session": "SESSION_TOKEN",
        "alias": "string",
        "creation_date": "2026-09-02T10:30:00.000Z",
        "duration": 1,
        "active": true,
        "passings": 1,
        "first": "2026-09-02T10:30:00.000Z",
        "last": "2026-09-02T10:30:00.000Z"
      }
    ]
  }
}

Modelo de esquema

El objeto SessionsListResponse

Definición del objeto SessionsListResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": [
      {
        "token_session": "SESSION_TOKEN",
        "alias": "string",
        "creation_date": "2026-09-02T10:30:00.000Z",
        "duration": 1,
        "active": true,
        "passings": 1
      }
    ]
  }
}

Modelo de esquema

El objeto Passing

Definición del objeto Passing.

Campo	Tipo	Obligatorio	Descripción
`timestamp`	string<date-time>	Obligatorio	—
`num_passing`	integer	Obligatorio	—
`bib`	string	Obligatorio	—
`participant_id`	string \| null	Opcional	—
`chip`	string \| null	Opcional	—
`latitude`	number \| null	Opcional	—
`longitude`	number \| null	Opcional	—
`status`	string \| null	Opcional	—
`timezone`	string \| null	Opcional	—
`gender`	string \| null	Opcional	—

Ejemplo JSON

{
  "timestamp": "2026-09-02T10:30:00.000Z",
  "num_passing": 1,
  "bib": "string",
  "participant_id": "string",
  "chip": "string",
  "latitude": 1,
  "longitude": 1,
  "status": "string",
  "timezone": "string",
  "gender": "string"
}

Modelo de esquema

El objeto InsertPassingsRequest

Definición del objeto InsertPassingsRequest.

Campo	Tipo	Obligatorio	Descripción
`token_session`	string	Obligatorio	—
`passings_list`	array<Passing>	Obligatorio	—

Ejemplo JSON

{
  "token_session": "SESSION_TOKEN",
  "passings_list": [
    {
      "timestamp": "2026-09-02T10:30:00.000Z",
      "num_passing": 1,
      "bib": "string",
      "participant_id": "string",
      "chip": "string",
      "latitude": 1,
      "longitude": 1,
      "status": "string",
      "timezone": "string",
      "gender": "string"
    }
  ]
}

Modelo de esquema

El objeto InsertPassingsResponse

Definición del objeto InsertPassingsResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "token_session": "SESSION_TOKEN",
    "inserted_count": 1,
    "duplicate_count": 1
  }
}

Modelo de esquema

El objeto PassingsListResponse

Definición del objeto PassingsListResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": [
      {
        "timestamp": "2026-09-02T10:30:00.000Z",
        "num_passing": 1,
        "bib": "string",
        "participant_id": "string",
        "chip": "string",
        "latitude": 1,
        "longitude": 1,
        "status": "string",
        "timezone": "string",
        "gender": "string"
      }
    ]
  }
}

Modelo de esquema

El objeto EventSummary

Definición del objeto EventSummary.

Campo	Tipo	Obligatorio	Descripción
`event_token`	string	Obligatorio	—
`name`	string \| null	Opcional	—
`edition`	string \| null	Opcional	—
`location`	string \| null	Opcional	—
`start_date`	string<date-time> \| null	Opcional	—
`end_date`	string<date-time> \| null	Opcional	—
`status`	string \| null	Opcional	—

Ejemplo JSON

{
  "event_token": "EVENT_TOKEN",
  "name": "Sample name",
  "edition": "string",
  "location": "string",
  "start_date": "2026-09-02T10:30:00.000Z",
  "end_date": "2026-09-02T10:30:00.000Z",
  "status": "string"
}

Modelo de esquema

El objeto EventsListResponse

Definición del objeto EventsListResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": [
      {
        "event_token": "EVENT_TOKEN",
        "name": "Sample name",
        "edition": "string",
        "location": "string",
        "start_date": "2026-09-02T10:30:00.000Z",
        "end_date": "2026-09-02T10:30:00.000Z",
        "status": "string"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 1,
      "has_more": true
    }
  }
}

Modelo de esquema

El objeto EventGetResponse

Definición del objeto EventGetResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": {}
  }
}

Modelo de esquema

El objeto CustomField

Definición del objeto CustomField.

Campo	Tipo	Obligatorio	Descripción
`field_name`	string	Obligatorio	—
`value`	string \| null	Obligatorio	—

Ejemplo JSON

{
  "field_name": "Sample name",
  "value": "string"
}

Modelo de esquema

El objeto Participante

Definición del objeto Participant.

Campo	Tipo	Obligatorio	Descripción
`name`	string	Obligatorio	—
`lastname`	string \| null	Opcional	—
`bib`	string \| null	Obligatorio	—
`chip`	string \| null	Opcional	—
`gender`	string \| null	Opcional	—
`dob`	string<date-time> \| null	Opcional	—
`yob`	integer \| null	Opcional	—
`country`	string \| null	Opcional	—
`city`	string \| null	Opcional	—
`age_group`	string \| null	Opcional	—
`team`	string \| null	Opcional	—
`club`	string \| null	Opcional	—
`email`	string<email> \| null	Opcional	—
`telephone`	string \| null	Opcional	—
`group_id`	string \| null	Opcional	—
`race_token`	string \| null	Opcional	—
`custom_fields`	array<CustomField>	Opcional	—
`individual_start_time`	string \| null	Opcional	HH:mm:ss

Ejemplo JSON

{
  "name": "Sample name",
  "lastname": "Sample name",
  "bib": "string",
  "chip": "string",
  "gender": "string",
  "dob": "2026-09-02T10:30:00.000Z",
  "yob": 1,
  "country": "string",
  "city": "string",
  "age_group": "string",
  "team": "string",
  "club": "string",
  "email": "timer@example.com",
  "telephone": "string",
  "group_id": "string",
  "race_token": "string",
  "custom_fields": [
    {
      "field_name": "Sample name",
      "value": "string"
    }
  ],
  "individual_start_time": "string"
}

Modelo de esquema

El objeto CreateParticipantRequest

Definición del objeto CreateParticipantRequest.

Este esquema no define propiedades con nombre.

Ejemplo JSON

{
  "name": "Sample name",
  "lastname": "Sample name",
  "bib": "string",
  "chip": "string",
  "gender": "string",
  "dob": "2026-09-02T10:30:00.000Z",
  "yob": 1,
  "country": "string",
  "city": "string",
  "age_group": "string",
  "team": "string",
  "club": "string",
  "email": "timer@example.com",
  "telephone": "string",
  "group_id": "string",
  "race_token": "string",
  "custom_fields": [
    {
      "field_name": "Sample name",
      "value": "string"
    }
  ],
  "individual_start_time": "string"
}

Modelo de esquema

El objeto ParticipantSummary

Definición del objeto ParticipantSummary.

Campo	Tipo	Obligatorio	Descripción
`event_token`	string	Obligatorio	—
`participant_token`	string	Obligatorio	—
`name`	string	Obligatorio	—
`lastname`	string \| null	Opcional	—
`bib`	string \| null	Opcional	—
`chip`	string \| null	Opcional	—
`status`	string \| null	Opcional	—
`gender`	string \| null	Opcional	—
`dob`	string<date-time> \| null	Opcional	—
`yob`	integer \| null	Opcional	—
`country`	string \| null	Opcional	—
`city`	string \| null	Opcional	—
`age_group`	string \| null	Opcional	—
`team`	string \| null	Opcional	—
`club`	string \| null	Opcional	—
`email`	string<email> \| null	Opcional	—
`telephone`	string \| null	Opcional	—
`group_id`	string \| null	Opcional	—
`race_token`	string \| null	Opcional	—
`custom_fields`	array<CustomField>	Opcional	—
`individual_start_time`	string \| null	Opcional	—

Ejemplo JSON

{
  "event_token": "EVENT_TOKEN",
  "participant_token": "PARTICIPANT_TOKEN",
  "name": "Sample name",
  "lastname": "Sample name",
  "bib": "string",
  "chip": "string",
  "status": "string",
  "gender": "string",
  "dob": "2026-09-02T10:30:00.000Z",
  "yob": 1,
  "country": "string",
  "city": "string",
  "age_group": "string",
  "team": "string",
  "club": "string",
  "email": "timer@example.com",
  "telephone": "string",
  "group_id": "string",
  "race_token": "string",
  "custom_fields": [
    {
      "field_name": "Sample name",
      "value": "string"
    }
  ],
  "individual_start_time": "string"
}

Modelo de esquema

El objeto ParticipantsListResponse

Definición del objeto ParticipantsListResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": [
      {
        "event_token": "EVENT_TOKEN",
        "participant_token": "PARTICIPANT_TOKEN",
        "name": "Sample name",
        "lastname": "Sample name",
        "bib": "string",
        "chip": "string",
        "status": "string",
        "gender": "string",
        "dob": "2026-09-02T10:30:00.000Z",
        "yob": 1,
        "country": "string",
        "city": "string",
        "age_group": "string",
        "team": "string",
        "club": "string",
        "email": "timer@example.com",
        "telephone": "string",
        "group_id": "string",
        "race_token": "string",
        "custom_fields": [
          {
            "field_name": "Sample name",
            "value": "string"
          }
        ],
        "individual_start_time": "string"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 1,
      "has_more": true
    }
  }
}

Modelo de esquema

El objeto ParticipantGetResponse

Definición del objeto ParticipantGetResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "result": {
      "event_token": "EVENT_TOKEN",
      "participant_token": "PARTICIPANT_TOKEN",
      "name": "Sample name",
      "lastname": "Sample name",
      "bib": "string",
      "chip": "string",
      "status": "string",
      "gender": "string",
      "dob": "2026-09-02T10:30:00.000Z",
      "yob": 1,
      "country": "string",
      "city": "string",
      "age_group": "string",
      "team": "string",
      "club": "string",
      "email": "timer@example.com",
      "telephone": "string",
      "group_id": "string",
      "race_token": "string",
      "custom_fields": [
        {
          "field_name": "Sample name",
          "value": "string"
        }
      ],
      "individual_start_time": "string"
    }
  }
}

Modelo de esquema

El objeto CreateParticipantResponse

Definición del objeto CreateParticipantResponse.

Campo	Tipo	Obligatorio	Descripción
`body`	object	Obligatorio	—

Ejemplo JSON

{
  "body": {
    "description": "string",
    "event_token": "EVENT_TOKEN",
    "participant_token": "PARTICIPANT_TOKEN",
    "result": {}
  }
}