RUFUS Help

Modelo do esquema

O envelopeQualquer objeto

Definição do objeto EnvelopeAny.

Campo	Tipo	Obrigatório	Descrição
`body`	any	Opcional	Operation result body.

Exemplo JSON

{
  "body": "string"
}

Modelo do esquema

O objeto EnvelopeNull

Definição do objeto EnvelopeNull.

Campo	Tipo	Obrigatório	Descrição
`body`	any \| null	Obrigatório	—

Exemplo JSON

{
  "body": "string"
}

Modelo do esquema

O objeto de paginação

Definição do objeto Pagination.

Campo	Tipo	Obrigatório	Descrição
`page`	integer	Obrigatório	—
`limit`	integer	Obrigatório	—
`total`	integer	Obrigatório	—
`has_more`	boolean	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto DeviceSummary

Definição do objeto DeviceSummary.

Campo	Tipo	Obrigatório	Descrição
`deviceid`	string	Obrigatório	—
`type`	string	Obrigatório	—
`model`	string	Obrigatório	—
`alias`	string	Obrigatório	—
`firmware`	string \| null	Opcional	—
`serial_number`	string	Obrigatório	—
`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	—

Exemplo 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 do esquema

O objeto DeviceDetails

Definição do objeto DeviceDetails.

Este esquema não define propriedades nomeadas.

Exemplo 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 do esquema

O objeto BindDeviceRequest

Definição do objeto BindDeviceRequest.

Campo	Tipo	Obrigatório	Descrição
`type`	string	Obrigatório	—
`model`	string	Obrigatório	—
`serial_number`	string	Obrigatório	—
`alias`	string	Opcional	—
`firmware`	string	Opcional	—

Exemplo JSON

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

Modelo do esquema

O objeto BindDeviceResponse

Definição do objeto BindDeviceResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto UnbindDeviceResponse

Definição do objeto UnbindDeviceResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto DevicesListResponse

Definição do objeto DevicesListResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto DeviceGetResponse

Definição do objeto DeviceGetResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto DeviceTelemetryRequest

At least one telemetry field is required.

Campo	Tipo	Obrigatório	Descrição
`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	—

Exemplo 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 do esquema

O objeto DeviceTelemetryResponse

Definição do objeto DeviceTelemetryResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto CreateSessionRequest

Definição do objeto CreateSessionRequest.

Campo	Tipo	Obrigatório	Descrição
`deviceid`	string	Obrigatório	—
`alias`	string	Opcional	—

Exemplo JSON

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

Modelo do esquema

O objeto CreateSessionResponse

Definição do objeto CreateSessionResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto CloseSessionResponse

Definição do objeto CloseSessionResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto SessionDetails

Definição do objeto SessionDetails.

Campo	Tipo	Obrigatório	Descrição
`token_session`	string	Obrigatório	—
`alias`	string	Obrigatório	—
`creation_date`	string<date-time>	Opcional	—
`duration`	number \| null	Opcional	—
`active`	boolean	Obrigatório	—
`passings`	integer	Opcional	—
`first`	string<date-time> \| null	Opcional	—
`last`	string<date-time> \| null	Opcional	—

Exemplo 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 do esquema

O objeto SessionSummary

Definição do objeto SessionSummary.

Campo	Tipo	Obrigatório	Descrição
`token_session`	string	Obrigatório	—
`alias`	string	Obrigatório	—
`creation_date`	string<date-time>	Opcional	—
`duration`	number \| null	Opcional	—
`active`	boolean	Obrigatório	—
`passings`	integer	Opcional	—

Exemplo JSON

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

Modelo do esquema

O objeto SessionGetResponse

Definição do objeto SessionGetResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto SessionsListResponse

Definição do objeto SessionsListResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto de passagem

Definição do objeto Passing.

Campo	Tipo	Obrigatório	Descrição
`timestamp`	string<date-time>	Obrigatório	—
`num_passing`	integer	Obrigatório	—
`bib`	string	Obrigatório	—
`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	—

Exemplo 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 do esquema

O objeto InsertPassingsRequest

Definição do objeto InsertPassingsRequest.

Campo	Tipo	Obrigatório	Descrição
`token_session`	string	Obrigatório	—
`passings_list`	array<Passing>	Obrigatório	—

Exemplo 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 do esquema

O objeto InsertPassingsResponse

Definição do objeto InsertPassingsResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto PassingsListResponse

Definição do objeto PassingsListResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto EventSummary

Definição do objeto EventSummary.

Campo	Tipo	Obrigatório	Descrição
`event_token`	string	Obrigatório	—
`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	—

Exemplo 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 do esquema

O objeto EventsListResponse

Definição do objeto EventsListResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto EventGetResponse

Definição do objeto EventGetResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto CustomField

Definição do objeto CustomField.

Campo	Tipo	Obrigatório	Descrição
`field_name`	string	Obrigatório	—
`value`	string \| null	Obrigatório	—

Exemplo JSON

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

Modelo do esquema

O objeto Participante

Definição do objeto Participant.

Campo	Tipo	Obrigatório	Descrição
`name`	string	Obrigatório	—
`lastname`	string \| null	Opcional	—
`bib`	string \| null	Obrigatório	—
`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

Exemplo 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 do esquema

O objeto CreateParticipantRequest

Definição do objeto CreateParticipantRequest.

Este esquema não define propriedades nomeadas.

Exemplo 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 do esquema

O objeto ParticipantSummary

Definição do objeto ParticipantSummary.

Campo	Tipo	Obrigatório	Descrição
`event_token`	string	Obrigatório	—
`participant_token`	string	Obrigatório	—
`name`	string	Obrigatório	—
`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	—

Exemplo 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 do esquema

O objeto ParticipantsListResponse

Definição do objeto ParticipantsListResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto ParticipantGetResponse

Definição do objeto ParticipantGetResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo 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 do esquema

O objeto CreateParticipantResponse

Definição do objeto CreateParticipantResponse.

Campo	Tipo	Obrigatório	Descrição
`body`	object	Obrigatório	—

Exemplo JSON

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