RUFUS Help

Schema model

The EnvelopeAny object

Definition of the EnvelopeAny object.

Field	Type	Required	Description
`body`	any	Optional	Operation result body.

Example JSON

{
  "body": "string"
}

Schema model

The EnvelopeNull object

Definition of the EnvelopeNull object.

Field	Type	Required	Description
`body`	any \| null	Required	—

Example JSON

{
  "body": "string"
}

Schema model

The Pagination object

Definition of the Pagination object.

Field	Type	Required	Description
`page`	integer	Required	—
`limit`	integer	Required	—
`total`	integer	Required	—
`has_more`	boolean	Required	—

Example JSON

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

Schema model

The DeviceSummary object

Definition of the DeviceSummary object.

Field	Type	Required	Description
`deviceid`	string	Required	—
`type`	string	Required	—
`model`	string	Required	—
`alias`	string	Required	—
`firmware`	string \| null	Optional	—
`serial_number`	string	Required	—
`last_login`	string<date-time> \| null	Optional	—
`creation_date`	string<date-time> \| null	Optional	—
`sessions`	integer	Optional	—
`device_status`	string \| null	Optional	—
`battery_percentage`	integer \| null	Optional	—
`charging`	boolean \| null	Optional	—
`last_telemetry_at`	string<date-time> \| null	Optional	—
`last_reported_latitude`	number \| null	Optional	—
`last_reported_longitude`	number \| null	Optional	—

Example 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
}

Schema model

The DeviceDetails object

Definition of the DeviceDetails object.

This schema does not define named properties.

Example 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
}

Schema model

The BindDeviceRequest object

Definition of the BindDeviceRequest object.

Field	Type	Required	Description
`type`	string	Required	—
`model`	string	Required	—
`serial_number`	string	Required	—
`alias`	string	Optional	—
`firmware`	string	Optional	—

Example JSON

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

Schema model

The BindDeviceResponse object

Definition of the BindDeviceResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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

Schema model

The UnbindDeviceResponse object

Definition of the UnbindDeviceResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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

Schema model

The DevicesListResponse object

Definition of the DevicesListResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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
    }
  }
}

Schema model

The DeviceGetResponse object

Definition of the DeviceGetResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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
    }
  }
}

Schema model

The DeviceTelemetryRequest object

At least one telemetry field is required.

Field	Type	Required	Description
`reported_at`	string<date-time>	Optional	—
`device_status`	string	Optional	—
`battery_percentage`	integer	Optional	—
`battery_volts`	number	Optional	—
`charging`	boolean	Optional	—
`temperature_celsius`	integer	Optional	—
`latitude`	number	Optional	—
`longitude`	number	Optional	—
`gps_accuracy_m`	number	Optional	—
`network_type`	string	Optional	—
`signal_strength`	integer	Optional	—

Example 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
}

Schema model

The DeviceTelemetryResponse object

Definition of the DeviceTelemetryResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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
    }
  }
}

Schema model

The CreateSessionRequest object

Definition of the CreateSessionRequest object.

Field	Type	Required	Description
`deviceid`	string	Required	—
`alias`	string	Optional	—

Example JSON

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

Schema model

The CreateSessionResponse object

Definition of the CreateSessionResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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

Schema model

The CloseSessionResponse object

Definition of the CloseSessionResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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

Schema model

The SessionDetails object

Definition of the SessionDetails object.

Field	Type	Required	Description
`token_session`	string	Required	—
`alias`	string	Required	—
`creation_date`	string<date-time>	Optional	—
`duration`	number \| null	Optional	—
`active`	boolean	Required	—
`passings`	integer	Optional	—
`first`	string<date-time> \| null	Optional	—
`last`	string<date-time> \| null	Optional	—

Example 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"
}

Schema model

The SessionSummary object

Definition of the SessionSummary object.

Field	Type	Required	Description
`token_session`	string	Required	—
`alias`	string	Required	—
`creation_date`	string<date-time>	Optional	—
`duration`	number \| null	Optional	—
`active`	boolean	Required	—
`passings`	integer	Optional	—

Example JSON

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

Schema model

The SessionGetResponse object

Definition of the SessionGetResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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"
      }
    ]
  }
}

Schema model

The SessionsListResponse object

Definition of the SessionsListResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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
      }
    ]
  }
}

Schema model

The Passing object

Definition of the Passing object.

Field	Type	Required	Description
`timestamp`	string<date-time>	Required	—
`num_passing`	integer	Required	—
`bib`	string	Required	—
`participant_id`	string \| null	Optional	—
`chip`	string \| null	Optional	—
`latitude`	number \| null	Optional	—
`longitude`	number \| null	Optional	—
`status`	string \| null	Optional	—
`timezone`	string \| null	Optional	—
`gender`	string \| null	Optional	—

Example 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"
}

Schema model

The InsertPassingsRequest object

Definition of the InsertPassingsRequest object.

Field	Type	Required	Description
`token_session`	string	Required	—
`passings_list`	array<Passing>	Required	—

Example 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"
    }
  ]
}

Schema model

The InsertPassingsResponse object

Definition of the InsertPassingsResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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

Schema model

The PassingsListResponse object

Definition of the PassingsListResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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"
      }
    ]
  }
}

Schema model

The EventSummary object

Definition of the EventSummary object.

Field	Type	Required	Description
`event_token`	string	Required	—
`name`	string \| null	Optional	—
`edition`	string \| null	Optional	—
`location`	string \| null	Optional	—
`start_date`	string<date-time> \| null	Optional	—
`end_date`	string<date-time> \| null	Optional	—
`status`	string \| null	Optional	—

Example 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"
}

Schema model

The EventsListResponse object

Definition of the EventsListResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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
    }
  }
}

Schema model

The EventGetResponse object

Definition of the EventGetResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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

Schema model

The CustomField object

Definition of the CustomField object.

Field	Type	Required	Description
`field_name`	string	Required	—
`value`	string \| null	Required	—

Example JSON

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

Schema model

The Participant object

Definition of the Participant object.

Field	Type	Required	Description
`name`	string	Required	—
`lastname`	string \| null	Optional	—
`bib`	string \| null	Required	—
`chip`	string \| null	Optional	—
`gender`	string \| null	Optional	—
`dob`	string<date-time> \| null	Optional	—
`yob`	integer \| null	Optional	—
`country`	string \| null	Optional	—
`city`	string \| null	Optional	—
`age_group`	string \| null	Optional	—
`team`	string \| null	Optional	—
`club`	string \| null	Optional	—
`email`	string<email> \| null	Optional	—
`telephone`	string \| null	Optional	—
`group_id`	string \| null	Optional	—
`race_token`	string \| null	Optional	—
`custom_fields`	array<CustomField>	Optional	—
`individual_start_time`	string \| null	Optional	HH:mm:ss

Example 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"
}

Schema model

The CreateParticipantRequest object

Definition of the CreateParticipantRequest object.

This schema does not define named properties.

Example 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"
}

Schema model

The ParticipantSummary object

Definition of the ParticipantSummary object.

Field	Type	Required	Description
`event_token`	string	Required	—
`participant_token`	string	Required	—
`name`	string	Required	—
`lastname`	string \| null	Optional	—
`bib`	string \| null	Optional	—
`chip`	string \| null	Optional	—
`status`	string \| null	Optional	—
`gender`	string \| null	Optional	—
`dob`	string<date-time> \| null	Optional	—
`yob`	integer \| null	Optional	—
`country`	string \| null	Optional	—
`city`	string \| null	Optional	—
`age_group`	string \| null	Optional	—
`team`	string \| null	Optional	—
`club`	string \| null	Optional	—
`email`	string<email> \| null	Optional	—
`telephone`	string \| null	Optional	—
`group_id`	string \| null	Optional	—
`race_token`	string \| null	Optional	—
`custom_fields`	array<CustomField>	Optional	—
`individual_start_time`	string \| null	Optional	—

Example 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"
}

Schema model

The ParticipantsListResponse object

Definition of the ParticipantsListResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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
    }
  }
}

Schema model

The ParticipantGetResponse object

Definition of the ParticipantGetResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example 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"
    }
  }
}

Schema model

The CreateParticipantResponse object

Definition of the CreateParticipantResponse object.

Field	Type	Required	Description
`body`	object	Required	—

Example JSON

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