nc 192.168.1.10 8080
Timing interface
Status interface
Configuration interface
Backup interface
GPS Interface
Filters Interface
Cloud interface
Required tools
Top cover detached
View of the double bottom removed
View of the double bottom removed
Impinj reader attached to the double bottom base
Zebra reader attached to the double bottom base
Chainway reader attached to the double bottom base
Ethernet cable and power cable connected to the reader
| Method | Pros | Cons | Best Use Case |
|---|---|---|---|
| NTP | - Automatic and accurate - Ideal for connected environments | - Requires internet access - Dependent on external servers | Events with stable internet or local network connectivity |
| GPS | - Highly accurate - Works without internet access | - Requires clear view of sky - Not ideal for indoor events | Outdoor events or mobile race setups |
| Manual | - No external dependencies - Easy to configure | - Prone to human error - No automatic adjustments | Backup or isolated scenarios |
RUFUS Adquisition Menu
CloudBox Adquisition
Cloudbox Adquisition Properties
| GPS Status | Meaning | Action |
| STARTING | The system is initializing GPS positioning | Wait for the system to start acquiring a signal. |
| SEARCHING | The system is searching for GPS satellites | Ensure antenna placement is optimal and in clear view of the sky. |
| GPS_ERROR | Incorrect or incomplete GPS information obtained | System continues to retry; check for possible obstructions. |
| TIMEOUT | GPS retries exceeded, modem resumes internet connection | System stops searching after 10 retries if a SIM PIN is present. |
| SYSTEM_LOCATED | GPS coordinates successfully obtained | Google Maps link is generated for precise location tracking. |
Bib filters
Bib filters add range modal
Cross-reference tables
Add cross-reference table modal
Antenna test
](https://help.runonrufus.com/rufus-timing-app/settings-and-configuration/setting-up-tag-types-for-rfid-readers) # Warning! ## Warning Before operating the CloudBox and its associated components, it is essential to understand the critical warnings and guidelines to ensure safe and proper use of the system. Following these warnings will help prevent damage to your equipment and ensure accurate, high-quality race timing services. ### Read the Documentation Carefully Before using the CloudBox system, thoroughly read all the documentation provided. This includes setup guides, operational instructions, and maintenance recommendations. Operating the system without sufficient knowledge may result in errors, misconfiguration, or potential damage. ### Protect the CloudBox from Extreme Weather Conditions The CloudBox is designed for outdoor race timing environments, but it must always be protected from extreme weather conditions such as **direct sunlight, excessive heat, heavy rain, and water spray**. Never place the CloudBox under direct sunlight. Always place the system in a **shaded area** with proper air ventilation. Be especially careful when placing the CloudBox on hot surfaces such as **asphalt, concrete, or other heat-retaining floors**, as these surfaces can increase the internal temperature of the system. When operating in hot weather, place the CloudBox on a cooler, stable surface or raise it from the ground when necessary. The CloudBox must also be protected from water exposure. Never leave the system unprotected under heavy rain. Prevent the CloudBox from being hit by shower spray, hose spray, or wind-driven rain. Use an appropriate protective cover or sheltered location whenever weather conditions may expose the system to water or excessive heat. ### Do Not Manipulate the RFID Reader While Powered Avoid handling or manipulating the RFID reader while the system is powered on. Always connect or disconnect the reader from its power source with the system turned off to prevent electrical damage or communication failures. ### Test the System Before Every Event Never attend a race or timing event without fully testing all system components. Ensure that both hardware components, including the CloudBox, RFID readers, antennas, and tags, and software are functioning correctly. Familiarize yourself with both the hardware and software aspects of the CloudBox to provide an error-free, high-quality timing service. Lack of system knowledge could lead to serious problems during an event. ### Inform Competitors on Proper Tag Usage Always educate competitors on the correct placement and use of the tags for their particular event. The success of timing heavily relies on proper tag placement, whether on the body, bicycle, or vehicle. Incorrectly placed tags can lead to missed readings and increase the system's error margin. Properly installed tags result in a failure rate of less than 0.5%. ### Avoid Improper Tag Placement Never place tags in untested areas or on surfaces that could interfere with RFID signals, such as: * Metal surfaces * Human bodies or water-heavy areas Improper tag placement can significantly reduce the reader’s ability to detect tags. Always conduct thorough testing before installation and receive approval from the manufacturer if necessary. ### Use Only Approved Accessories and Components Only use accessories, replacement parts, and tags that are provided or approved by RUFUS. Do not connect unauthorized accessories or use unapproved RFID tags, as this may cause system malfunctions or inaccurate results. For any additional components or third-party accessories, obtain express approval from RUFUS before integrating them into your setup. ### Summary By adhering to these important warnings, you ensure the safe and effective operation of your CloudBox timing system. Taking the time to properly test the system, protect it from extreme weather conditions, inform competitors, and only use authorized components will help avoid errors and guarantee a successful timing experience. Always follow the provided documentation and seek assistance from the manufacturer when needed to maintain optimal performance. # Battery Care The **CloudBox** uses high-quality **lithium batteries** to ensure reliable performance during race timing events. Proper care and maintenance of these batteries are essential to extend their lifespan and ensure optimal performance. This article will cover key points about the first use, charging, discharging, storage and monitoring, of the CloudBox battery. ## First Use When you receive a new CloudBox, the lithium battery will have some charge remaining. You can start using the system immediately and recharge the battery after using up the remaining power. After **2-3 full charge and discharge cycles**, the lithium battery will be fully activated, and you’ll achieve the battery’s full capacity and performance. ## Charging the Battery **Proper charging habits** are essential for maintaining the long-term health of the CloudBox battery. Follow these tips to charge your device correctly: 1. **Unplug When Fully Charged**: * When the battery reaches full charge, **unplug the charger** as soon as possible to avoid slow trickle charging. Leaving the battery connected at full charge for extended periods can increase the battery's stress level, which may lead to degradation over time. 2. **Avoid Recharging When Already at 80% or Higher**: * If the battery level is already at **80% or higher**, it’s best not to recharge it immediately before use. Instead, wait until the battery is lower to recharge for better long-term performance. 3. **Charge the Battery Above 30%**: * If the battery level is low, make sure to recharge it to at least **30% or higher** before using the CloudBox again. Avoid charging the battery only partially (e.g., 20%) and then using it, as this can impact performance. 4. **Post-Charge Wait Time**: * After fully charging the CloudBox, let it rest for about **30 seconds** before putting it back into use. This allows the battery to stabilize, ensuring better performance during operation. 5. **Temperature Considerations**: * The charging temperature for lithium batteries should be between **0°C and 45°C**, and the discharge temperature should be between **-20°C and 60°C**. Always be mindful of these temperature limits to prevent damage. ## Discharging the Battery **Avoid over-discharging** the CloudBox battery, as this can cause permanent damage and reduce the battery's overall capacity. 1. **Charge Immediately When Low**: * When the CloudBox indicates that the battery level is low, start charging it immediately. Continuous usage on a low battery can lead to an irreversible loss of capacity. 2. **Impact of Environment**: * **High temperature and humidity** can accelerate the self-discharge rate of lithium batteries. Make sure to store and operate the CloudBox in a controlled environment to prevent this from happening. The ideal operating temperature is **0°C to 20°C**. ## Storing the Battery If you need to store the CloudBox for an extended period, follow these guidelines to maintain battery health: 1. **Storage Charge Level**: * Store the CloudBox battery at **50-80% charge** if you plan to store it for a long time. This ensures the battery remains in good condition while minimizing stress on the cells. 2. **Recharge Every Three Months**: * Lithium batteries naturally self-discharge over time. To avoid excessive capacity loss, **recharge the battery every three months** during long-term storage. This helps prevent irreversible capacity loss caused by self-discharge. 3. **Optimal Storage Environment**: * Store the CloudBox in a dry environment with temperatures between **0°C and 20°C**. Avoid storing the CloudBox in extremely hot or humid conditions, as this can accelerate battery degradation. ## Monitoring the CloudBox Battery and Charging Status ### **When the System is On:** To check if your CloudBox is charging while powered on: * Go to the **STATUS** interface in the CloudBox dashboard. * Look for the **hasPower** indicator. If it shows **true**, your CloudBox is charging. ### **When the System is Off:** To check the charging status while the system is off: * Press and hold the **START** button. * If the **START LED** flashes **every 1 second**, this indicates the system is actively charging. By following these steps, you can ensure your CloudBox is properly charging both when it’s on or off. ## Summary By following these simple guidelines for **charging**, **discharging**, and **storing** the CloudBox battery, you’ll extend its lifespan and maintain peak performance. Proper battery care ensures that your CloudBox will be ready for action whenever you need it, whether it’s at the start of a major race or during long-term storage between events. # Taking Care of your CloudBox Proper care and maintenance of your CloudBox are essential to ensure optimal performance and long-term durability. The CloudBox is built for race timing environments, but it still requires careful protection from environmental conditions, improper handling, and accidental damage during events. In this article, we’ll cover best practices for protecting the system from water, heat, dust, and other potential hazards, as well as tips for taking care of the system during races. ## Environmental Considerations ### Water Exposure While the CloudBox includes protection for its internal components, the system is **not waterproof**. To prevent damage, always protect the CloudBox from rain, splashes, and water spray during outdoor races. We recommend using a waterproof cover that fits over the system or placing it in a sheltered location where water cannot directly reach the unit. Never leave the CloudBox unprotected under heavy rain. Also prevent the system from being hit by shower spray, hose spray, or wind-driven rain. If the system gets wet, immediately dry any visible water with a cloth. If the CloudBox powers off due to significant water exposure, do not attempt to power it on until you have contacted RUFUS Support for further assistance. ### Heat and Direct Sunlight Prolonged exposure to high temperatures can reduce the lifespan of the internal lithium batteries and affect overall system performance. Never place the CloudBox under direct sunlight. During races, always place the system in a **shaded area** with proper air ventilation. Be especially careful when placing the CloudBox on hot surfaces such as **asphalt, concrete, or other heat-retaining floors**. These surfaces can significantly increase the temperature around the system, especially during warm weather. When needed, raise the CloudBox from the ground or place it on a cooler, stable surface. **Storage recommendations:** * Do not store the CloudBox in areas where temperatures exceed 80°F / 26°C, especially for extended periods. * Avoid leaving the CloudBox inside hot vehicles, warehouses, or storage rooms exposed to high temperatures. * Store the system in a dry, ventilated place away from direct sunlight. ### Dust and Dirt Allowing dust and dirt to accumulate on the CloudBox can lead to issues and may affect internal components through the ventilation slots. After each event, use a slightly damp cloth to clean off any visible dirt or dust that has accumulated on the CloudBox. Regular cleaning prevents buildup and helps the system continue to function smoothly. ## Battery Care As the CloudBox ages, the internal lithium batteries will naturally experience a decrease in capacity. To maximize the lifespan of the battery, follow these guidelines: * Avoid charging the system while using the RFID reader, as this increases strain on the battery and can reduce its life over time. * Disconnect the charger once the battery is fully charged to prevent unnecessary charging cycles. * Avoid complete discharges. Keeping the battery charged, especially during storage, is key to preserving battery life. * Store the system with a charged battery to prevent power-related issues during the next race. For more detailed battery care instructions, refer to the article on **Battery Care**. ## Care During a Race On race day, your CloudBox may be exposed to various environmental and operational challenges. Follow these best practices to protect the system during the event. #### Place the CloudBox in a Safe and Protected Area Choose the CloudBox location carefully before starting the event. The system should be placed in a shaded, ventilated, and stable area. Avoid direct sunlight, heavy rain exposure, water spray, and hot floors such as asphalt or concrete. Make sure the selected location protects the CloudBox from weather conditions while still allowing proper cable routing and safe access to the antennas and reader. #### Delimiting the Space Athletes and spectators, especially children, tend to move freely around the race area and may interfere with sensitive equipment. It’s important to set up clear boundaries around your CloudBox and antennas to keep the area safe. Use traffic cones, barriers, or caution tape to establish a perimeter around the timing equipment, ensuring that athletes and the public do not unintentionally damage the system. #### Keep the Lid Closed When the CloudBox is actively in use during a race, keep the reader lid closed. This helps prevent dirt, water, or accidental contact from damaging internal components. It also reduces the risk of curious passersby interfering with the system. #### Protecting the Antennas The RFID antennas play a crucial role in detecting athlete passings. To ensure optimal performance: * Keep athletes and the public away from the antennas. * Make sure no one stands on or in front of the antennas, as this can compromise timing accuracy. * Remember that bodies, especially the human body, absorb radio waves, which reduces the RFID reading range. ## Summary Taking care of your CloudBox ensures that the system will last for many race events, providing accurate and reliable timing services. Keep the system dry, cool, shaded, ventilated, and clean. Always protect it from heavy rain, water spray, direct sunlight, excessive heat, and hot surfaces such as asphalt or concrete. During races, take precautions to protect the CloudBox, RFID reader, antennas, and cables from accidental damage. Following these guidelines will help you get the most out of your CloudBox and avoid unnecessary downtime or repairs. # General Recommendations Proper handling and maintenance of the CloudBox and its associated components are crucial for ensuring reliable and long-lasting performance. The following general recommendations cover key aspects such as electrostatic protection, temperature and humidity considerations, weather protection, handling and connecting cables, and synchronization of devices. Follow these guidelines to keep your CloudBox in optimal condition and avoid potential issues during race events. ## Protection and Handling ### Electrostatic Sensitivity The reader components are sensitive to electrostatic discharges. Handle the reader and antennas with care and avoid exposing them to sudden shocks or vibrations, as this can damage sensitive internal components. ### Avoid High Humidity Environments Prolonged exposure to high humidity can affect the performance and sensitivity of the reader and antennas. Always use and store the CloudBox in a dry environment. Avoid storing or operating the system in areas with high moisture levels. ### Temperature, Sunlight, and Heat Do not expose the CloudBox to direct sunlight or high temperatures for extended periods, as this can damage the system. Never place the CloudBox under direct sunlight during an event. Always place the system in a **shaded area** with proper air ventilation. Be especially careful when placing the CloudBox on hot surfaces such as **asphalt, concrete, or other heat-retaining floors**. These surfaces can increase the temperature around the system and may contribute to overheating or reduced battery lifespan. Avoid leaving the CloudBox or its components in hot environments, such as inside vehicles, warehouses, or storage areas, as this can lead to partial or complete failure of the reader or other internal components. Very low temperatures may affect battery performance and reduce the overall sensitivity of the reader. Keep the system at moderate temperatures whenever possible for optimal performance. ### Rain and Water Protection The CloudBox must always be protected from water exposure. Never leave the system unprotected under heavy rain. Prevent the CloudBox from being hit by shower spray, hose spray, or wind-driven rain. When using the CloudBox outdoors, place it in a sheltered location or use an appropriate protective cover that prevents water from reaching the unit directly, while still allowing proper air ventilation. If the CloudBox gets wet, dry any visible water immediately with a cloth. If the system powers off after significant water exposure, do not attempt to power it on again until you have contacted RUFUS Support. ## Cable Management and Connections ### Antenna Terminals There is high voltage on the antenna terminals. Avoid handling these terminals while the reader is powered on, as it can be harmful to your health. Do not connect or disconnect antennas while the reader is in Start Mode. Always ensure that the reader is powered off before attaching or detaching antennas. ### Secure and Properly Connect Cables Always ensure that cables are securely connected to their respective ports, but do not force or overtighten them. For most ports, such as USB, it is safe to connect and disconnect while the CloudBox is powered on. However, never disconnect any cable from its port while the reader is on, except for USB cables. Keep the antenna terminals clean, and avoid excessive pressure when connecting or disconnecting the antennas. ### Handling Antennas and Cables Antennas are water-resistant and can be used under rainy conditions. However, never submerge antennas in water, as this can damage both the antennas and the reader. When storing antennas, avoid bending or sharply folding the cables. Always keep them in smooth curves, store them in a dry, protected area, and cover connectors with the provided caps to protect them when not in use. Ensure that cables do not get pressed or damaged by the weight of the antennas or any other object. Always route cables securely to avoid wear and tear. ## Operation and Synchronization ### Reader Synchronization Ensure the CloudBox’s time is always synchronized with the local event time and the PC or system processing the timing data, whether offline or through backups. Before any timing event, verify that all readers are correctly synchronized to avoid timing discrepancies. ### Proper Power Cycling Always perform the shutdown process via the **Shutdown** option in the CloudBox interface before powering off the system. Do not use the physical power button for abrupt shutdowns, as this can cause errors during the next boot-up sequence. Allow at least 15 seconds between powering off and restarting the reader to ensure proper boot procedures. ## Network and Device Management ### Avoid IP Conflicts If using more than one CloudBox or reader in the same network, ensure that each device has a unique ID to avoid network conflicts caused by duplicate IP addresses. Reserved IP addresses should not be assigned to any other devices on the network. Conflicting IP addresses between devices can disrupt communication and lead to data loss. ### Pendrive Usage You can safely connect or disconnect a USB pendrive while in the main menu. Never connect or disconnect a pendrive during a download process, as this could cause data corruption. ## Recommendations for Race Day ### Protect Your Equipment During events, use cones, caution tape, barriers, or other methods to create a clear boundary around the CloudBox and antennas. This helps prevent athletes, spectators, or children from tampering with or damaging the system. Keep the reader lid closed on the CloudBox when it is actively being used to protect it from dirt, water, or accidental contact. ### Protect the CloudBox from Weather Conditions Before starting the event, choose a safe and protected location for the CloudBox. Place the system in a **shaded, ventilated, and stable area**. Avoid direct sunlight, heavy rain exposure, water spray, and hot floors such as asphalt or concrete. If the race area is exposed to rain, wind, or intense heat, use a protective setup that shields the CloudBox from water and direct sun while allowing air to circulate around the system. Do not cover the CloudBox in a way that blocks ventilation or traps heat inside the unit. ### Antenna Setup Ensure athletes do not stand or park in front of or over the antennas. The human body absorbs radio signals, which can reduce the effective reading range and negatively impact the system’s performance. ## Summary By following these general recommendations, you will ensure that your CloudBox remains in optimal working condition. Proper handling of cables, avoiding extreme environmental conditions, protecting the system from direct sunlight, heat, heavy rain, and water spray, ensuring synchronization, and carefully managing network settings are essential for a successful and error-free race timing experience. # Special Note on UHF Cables In any RFID-based timing system like the **CloudBox**, the **UHF cables** are vital components that ensure the smooth transmission of power and data between the reader and antennas. Proper handling, maintenance, and storage of these cables are critical for the overall success and reliability of your timing operation. ## Why UHF Cables Are Important UHF cables are responsible for transmitting the **power generated by the reader** to the antennas. They play a key role in ensuring that the RFID system operates at its full potential. Any damage to the cables can result in **loss of signal strength** and **poor performance** of the antennas, which may lead to missed athlete passings during races. ## Key Recommendations for UHF Cable Care 1. **Avoid Sharp Bends or Forceful Handling** * **Never bend UHF cables sharply** or apply excessive force when handling them. Cables contain delicate internal wiring that can become damaged if bent or twisted in the wrong way. * When rolling or unrolling cables, always do so gently to prevent internal breakages that can cause **power transmission loss**. 2. **Keep Connectors and Cables Clean and Dry** * **Moisture** can be highly damaging to both the cables and connectors, leading to corrosion and performance degradation. * Always keep the cables in **dry environments**, and ensure connectors are free from dust, dirt, and humidity. Use protective covers when the cables are not in use. 3. **Check for Internal Cable Damage** * Over time, repeated improper handling or poor storage can cause **internal damage** to cables, which may not be immediately visible. Damaged cables can result in a significant loss of transmission power, reducing the overall performance of the RFID system. * Regularly **inspect** cables for signs of wear or damage, and if you notice any drop in antenna performance, consider testing or replacing the cables. 4. **Avoid Cable Pressure** * **Never press or crush the cables** under the weight of the antenna or other heavy objects. Ensure that cables are laid in a **safe, unobstructed path** underneath or around the antennas during setup. * Protect the cables by placing them in the designated space below **floor antennas** or securing them away from foot traffic. 5. **Store Cables Properly** * After each event, **store cables correctly** by coiling them in loose, smooth loops. Ensure the cables are kept in a **dry, protected area**, away from sharp objects that might puncture or damage them. * Using the **provided protective covers** for connectors is highly recommended to prevent dust and moisture buildup. ## Why Cable Maintenance is Critical The **cables are an integral part** of the entire CloudBox system. Even though they may seem like minor components, they are just as important as the reader and antennas themselves. **Damaged or neglected cables can result in reduced signal strength**, inaccurate race timing, and potentially missed athlete passings. To ensure a successful timing operation, make UHF cable care and maintenance a priority. Properly cared for cables will last longer, transmit power more efficiently, and deliver consistent performance in even the most challenging environments. ## Summary **Take care of your UHF cables** to maintain the accuracy and reliability of your race timing system. Avoid sharp bends, keep them clean and dry, check for internal damage, and store them properly to protect the integrity of your timing setup. Always remember: **the cables are a fundamental part of the system—take care of them!** # FAQ Here’s a collection of common questions that race timers might have after reading through the CloudBox help documentation. These questions cover a wide range of topics related to setup, operation, maintenance, and troubleshooting. ## **1. How do I know the current IP address of my CloudBox?** The CloudBox uses a **fixed IP address** for Ethernet connections, which is displayed on the CloudBox’s **interface**. If connected via an external WiFi network, the IP address will be assigned via **DHCP**. To determine the Ethernet IP address, check the **SSID** of the WiFi Access Point, or access it via the **Status** interface. *** ## **2. Can I change the IP address of my CloudBox?** Yes, the Ethernet IP address is configurable. Navigate to the **Network Configuration** section of the CloudBox interface to change the IP address, subnet, and port. The system will restart for the changes to take effect. *** ## **3. How can I access the CloudBox interface if there are multiple CloudBoxes on the same network?** When multiple CloudBoxes are on the same network, you should access each CloudBox via its **unique IP address** rather than `cloudbox.local`, as the domain `cloudbox.local` is shared between all CloudBoxes. Always use the specific IP address for each device. *** ## **4. What happens if I start a timing session with the reader not properly connected?** If the reader is not detected or incorrectly connected when you try to start a session, you will receive a **READERNOTOK** response. Check the connection between the reader and the CloudBox and ensure it is properly configured before restarting the session. *** ## **5. How do I bind my CloudBox to the Cloud Service?** To bind your CloudBox, obtain a **bind token** from your Cloud account and enter it in the **Cloud Operations** section of the CloudBox interface. Once bound, the CloudBox will start sending timing data and system status to the Cloud for remote monitoring and management. *** ## **6. Can I use the CloudBox in a location without Ethernet or WiFi?** Yes, the CloudBox is equipped with a **4G modem** that can provide internet connectivity in areas where Ethernet or WiFi are not available. Ensure you have a compatible SIM card inserted and configured correctly, and check the modem status for a **CONNECTED** indication. *** ## **7. How do I update the firmware of my CloudBox?** The CloudBox automatically detects firmware updates when connected to the internet. If an update is available, you will see a notification on the **Status** interface. You can choose to **Reboot and install** the update, which will apply the new firmware and restart the system. *** ## **8. Can I retrieve old race data from the CloudBox?** Yes, you can use the **Rewind function** to retrieve passings stored in the CloudBox’s backup files. You can initiate this either via the **Backup interface** or through a TCP-connected client. If the CloudBox is bound to the Cloud, all retrieved passings will also be sent to the **Passing Ingestion service**. *** ## **9. What is the best way to care for the CloudBox battery?** To maximize the life of your CloudBox battery, avoid charging it while using the reader, disconnect it once fully charged, and always store the system with a partially charged battery (between **50-80%**). Never leave the battery fully discharged for long periods, and recharge it every three months during storage. *** ## **10. How do I protect the CloudBox and antennas during a race?** To protect the CloudBox during a race, use **barriers or cones** to create a boundary around the system and antennas. Keep the **lid closed** when the system is in active use to prevent dirt, water, or accidental interference. Ensure that athletes do not stand or walk near the antennas, as this can affect the reading range. *** ## **11. What should I do if my CloudBox gets wet?** If the CloudBox is exposed to water, immediately dry any visible moisture. If the system powers off due to water exposure, **do not attempt to power it back on**. Contact **RUFUS Support** for further assistance to avoid damaging the internal components. *** ## **12. Can I operate the CloudBox in extreme temperatures?** The CloudBox should not be exposed to extreme temperatures for prolonged periods. The ideal operating temperature is between **0°C and 45°C**. Extremely high or low temperatures can affect battery performance and reduce the system’s reliability. *** ## **13. How do I properly handle and store UHF cables?** UHF cables should be handled with care. **Avoid sharp bends** and pressure on the cables, and never disconnect them while the reader is powered on. Store cables in a dry area, coiled gently, and always use protective caps on connectors when not in use to prevent moisture or dirt from entering the cable ends. *** ## **14. Can I use more than one CloudBox on the same network?** Yes, but you must ensure that each CloudBox has a **unique ID** and a non-conflicting IP address. Duplicate IP addresses on the same network can cause communication errors and potential loss of data. *** ## **15. What happens if the GPS signal is weak or unavailable?** If the CloudBox is unable to obtain GPS data, it will continue to search for a signal. If a **SIM PIN** is required, the system will attempt to locate GPS coordinates **10 times** with a delay between attempts. If no SIM is inserted, the system will continue searching every minute. *** ## **16. Can I control the CloudBox remotely?** Yes, once the CloudBox is bound to the Cloud, you can use the **IoT service** to remotely issue commands such as **START**, **STOP**, and **SHUTDOWN**. This allows for full control of the timing session from your Cloud account or through the **RUFUS Race Manager (RRM)**. *** ## **17. Can I connect and disconnect a USB pendrive at any time?** You can safely connect and disconnect a USB pendrive. However, **do not** connect or disconnect the pendrive during a download process, as this can corrupt the data or cause the system to crash. *** ## **18. What should I do if I receive a READERNOTOK error?** A **READERNOTOK** error indicates that the reader is either not configured correctly or not connected. Check the connections and configuration in the **Reader Configuration** section of the CloudBox interface, and ensure that the reader is properly powered. *** ## **19. How do I know if my CloudBox is overheating?** The CloudBox will trigger a **high temperature alarm** if the internal temperature exceeds **70°C**. If the temperature reaches **78°C**, an audible alarm will sound, and the system will automatically activate the fan to cool down. *** ## **20. What does the "No service" network status mean?** If the network status displays **No service** (status code 0), it means the 4G modem cannot connect to a network, and only emergency calls are possible. Check the **SIM card**, antenna placement, and signal strength to troubleshoot the issue. # Common Problems and Troubleshooting Even with proper care and maintenance, occasional issues may arise when using the CloudBox system. Here’s a list of common problems that timers might encounter during setup or operation, along with troubleshooting steps to help resolve them. ## **1. Problem: Reader Not Detected (READERNOTOK Error)** **Symptoms**: * The system shows a **READERNOTOK** error during startup or when attempting to start a timing session. **Possible Causes**: * The reader is not properly connected to the CloudBox. * The reader model is not correctly configured in the CloudBox settings. * The reader may be powered off or malfunctioning. **Troubleshooting**: * Check the **cable connections** between the reader and the CloudBox. * Ensure the reader is powered on and receiving the correct voltage. * Verify that the **reader model** is correctly set in the **Reader Configuration** section of the CloudBox interface. * If using multiple antennas, ensure they are connected to the correct ports (e.g., start with port 1 for single antenna setups). * Restart the CloudBox and attempt to reconnect the reader. *** ## **2. Problem: CloudBox is Not Accessible via cloudbox.local** **Symptoms**: * Unable to access the CloudBox interface through `http://cloudbox.local`. **Possible Causes**: * Multiple CloudBox devices are connected to the same network, causing a conflict. * The DNS service on your computer may not resolve the address properly. **Troubleshooting**: * If multiple CloudBoxes are on the same network, access each one via its **IP address** instead of `cloudbox.local`. * Use the **fixed Ethernet IP address** to connect directly to the CloudBox (e.g., `http://192.168.1.10`). * Ensure your device is connected to the same network as the CloudBox (Ethernet or WiFi). * Clear your browser cache or try a different browser. *** ## **3. Problem: Cannot Connect to the Cloud** **Symptoms**: * The CloudBox fails to connect to the Cloud and shows an **IoT server connection error** or **No internet connection**. **Possible Causes**: * The CloudBox does not have an active internet connection (via Ethernet, WiFi, or 4G). * Network settings may be incorrect. * The 4G SIM card is not properly inserted or configured. **Troubleshooting**: * Verify that the CloudBox is connected to a network (Ethernet, WiFi, or 4G). * If using WiFi, check that the correct **SSID and password** are entered in the **Network Configuration** section. * If using 4G, check the **SIM card status** in the **System Status** section. Ensure the SIM PIN is entered if required. * Test the internet connection by pinging a known website or IP address from a device on the same network. * Restart the CloudBox to reinitialize the network connection. *** ## **4. Problem: GPS Not Acquiring Location** **Symptoms**: * The GPS status shows **SEARCHING** or **GPS\_ERROR** and does not locate the device’s position. **Possible Causes**: * The GPS antenna is not correctly connected or placed in a poor location. * Obstructions (e.g., buildings or trees) may be interfering with GPS signals. * The SIM PIN may not have been entered (if required). **Troubleshooting**: * Ensure the **GPS antenna** is connected and placed in an open area, ideally outside, where it has a clear view of the sky. * Check the **GPS status** in the **System Status** interface. If a SIM PIN is required, ensure it is entered correctly. * Wait a few minutes, as the GPS may take time to acquire a signal, especially in a new location. * If the GPS does not resolve, restart the CloudBox and try again. *** ## **5. Problem: Battery Drains Quickly** **Symptoms**: * The CloudBox’s battery discharges faster than expected, or the system powers off unexpectedly. **Possible Causes**: * The battery may have degraded over time. * The system is being operated in extreme temperatures. * The battery is not properly charged, or the charging method is incorrect. **Troubleshooting**: * Avoid using the CloudBox in **extreme heat or cold**, as these conditions can reduce battery performance. * Ensure the battery is fully charged before use, and unplug the charger once the battery is fully charged. * Check the **Battery Care** article for proper maintenance practices to extend battery life. * If the battery shows signs of severe degradation, consider replacing it. *** ## **6. Problem: Antennas Not Reading Tags Correctly** **Symptoms**: * Missed passings or inconsistent tag readings during a race. **Possible Causes**: * The antennas are not properly positioned or connected. * The athletes’ TAGs are improperly placed. * Obstructions are blocking the signal, such as people or objects standing near the antennas. **Troubleshooting**: * Ensure the antennas are **properly connected** and positioned. Antennas should be clear of obstructions and facing the correct direction. * Check that the TAGs are **correctly placed** on the athletes. Misplaced tags (e.g., on metal surfaces) can reduce reading accuracy. * Keep **spectators and athletes** from standing too close to the antennas, as the human body can absorb radio signals and reduce the effective reading range. *** ## **7. Problem: Unable to Rewind Backup Data** **Symptoms**: * The CloudBox fails to rewind backup data or the rewind function takes too long. **Possible Causes**: * The backup folder is too large, causing the rewind operation to take longer than expected. * There are no backup files available. **Troubleshooting**: * Clear unnecessary backups regularly to reduce the size of the backup folder. * Perform the rewind operation through the **CloudBox interface** or using the **TCP socket** commands, specifying a **start** and **end timestamp** if necessary. *** ## **8. Problem: Firmware Update Fails** **Symptoms**: * The CloudBox fails to update its firmware, or the system becomes unresponsive during an update. **Possible Causes**: * The CloudBox does not have a stable internet connection during the update. * The system was powered off or lost connection during the update process. **Troubleshooting**: * Ensure the CloudBox has a **stable internet connection** before starting the update. * Allow the update process to finish without interruption. The system will reboot automatically when the update is complete. * If the update fails, try again after restarting the CloudBox and ensuring the network connection is stable. *** ## **9. Problem: USB Pendrive Not Detected** **Symptoms**: * The CloudBox does not recognize a USB pendrive when inserted, or fails to save backup files to the pendrive. **Possible Causes**: * The USB pendrive is not formatted correctly. **Troubleshooting**: * Ensure the pendrive is **formatted to FAT32** and has a simple name (e.g., "PEN\_BACKUPS"). * If the issue persists, try a different USB drive or restart the CloudBox. *** ## **10. Problem: High Temperature Warning** **Symptoms**: * The CloudBox triggers a high-temperature warning and powers down unexpectedly. **Possible Causes**: * The system is operating in a hot environment or lacks proper ventilation. * The fan is not functioning, or the ventilation slots are blocked. **Troubleshooting**: * Ensure the CloudBox is placed in a **well-ventilated area**, away from direct sunlight and heat sources. * Check that the **cooling fan** is functioning correctly and that the ventilation slots are free of obstructions. * If the system overheats frequently, consider lowering the ambient temperature or using additional cooling methods. *** ## 11. Problem: Unable to Connect to IoT Service **Symptoms**: *IoT Status: false*\ *Message: Error connecting with IoT server: Failed to connect: aws-c-io: AWS\_IO\_TLS\_ERROR\_NEGOTIATION\_FAILURE, TLS (SSL) negotiation failed* **Possible Causes**: * The system’s **date and time** are incorrect, causing a failure during TLS negotiation for secure connections to the IoT server. **Troubleshooting**: 1. **Check the CloudBox Time**: * Access the **STATUS** interface to verify the date and time settings. 2. **Set Correct Time**: * Use the **NTP**, **GPS**, or **Manual** time synchronization options in the **CONFIG** interface to correct the time. 3. **Restart the CloudBox**: * After updating the time, restart the system to attempt reconnecting to the IoT service. ## Summary This list of common problems and troubleshooting tips should help resolve most issues that may arise during the operation of your CloudBox. By following these guidelines, you can ensure smooth, reliable performance for all your race timing needs. For persistent problems, contact **RUFUS Support** for further assistance. # RUFUS Tag Writer The **RUFUS Tag Writer** is a desktop UHF RFID reader/writer designed to help you code UHF chips for your events. It works with **RUFUS wet chips** and other compatible UHF tags, giving you a simple way to prepare participant tags before race day. With the Tag Writer software you can: * Encode EPC values into UHF chips. * Prepare tags for use with **RUFUS CloudBox** and the RUFUS Timing ecosystem. * Verify chips before deployment. ## Credentials To use the Tag Writer software you will need a **username and password**. * These credentials are **different from your RUFUS Cloud account**. * To request access, please contact us at: **
Profile page
Create new api key section
Company active api keys
```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Devices"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"DeviceTelemetryRequest":{"type":"object","additionalProperties":false,"description":"At least one telemetry field is required.","properties":{"reported_at":{"type":"string","format":"date-time"},"device_status":{"type":"string"},"battery_percentage":{"type":"integer","minimum":0,"maximum":100},"battery_volts":{"type":"number","minimum":0},"charging":{"type":"boolean"},"temperature_celsius":{"type":"integer","minimum":-100,"maximum":200},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"gps_accuracy_m":{"type":"number","minimum":0},"network_type":{"type":"string"},"signal_strength":{"type":"integer","minimum":-200,"maximum":200}}},"DeviceTelemetryResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"deviceid":{"type":"string"},"result":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"last_telemetry_at":{"type":"string","format":"date-time"},"device_status":{"type":"string","nullable":true},"battery_percentage":{"type":"integer","nullable":true},"battery_volts":{"type":"number","nullable":true},"charging":{"type":"boolean","nullable":true},"temperature_celsius":{"type":"integer","nullable":true},"last_reported_latitude":{"type":"number","nullable":true},"last_reported_longitude":{"type":"number","nullable":true},"gps_accuracy_m":{"type":"number","nullable":true},"network_type":{"type":"string","nullable":true},"signal_strength":{"type":"integer","nullable":true}}}},"required":["description","deviceid"]}},"required":["body"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"PayloadTooLarge":{"description":"Payload too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/devices/{deviceid}/status":{"patch":{"tags":["Devices"],"summary":"Report device telemetry/status","description":"Requires `WRITE` or `READ_WRITE` api key access type.\n\nStale updates are ignored if `reported_at` is older than the current `last_telemetry_at`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTelemetryRequest"}}}},"responses":{"200":{"description":"Updated (or ignored if stale)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTelemetryResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` # Sessions ## Create session > Requires \`WRITE\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Sessions"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"CreateSessionRequest":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"alias":{"type":"string"}},"required":["deviceid"]},"CreateSessionResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"token_session":{"type":"string"}},"required":["description","token_session"]}},"required":["body"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/sessions":{"post":{"tags":["Sessions"],"summary":"Create session","description":"Requires `WRITE` or `READ_WRITE` api key access type.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSessionRequest"}}}},"responses":{"201":{"description":"Session inserted succesfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSessionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Get session by token > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Sessions"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"SessionGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SessionDetails"}}},"required":["description"]}},"required":["body"]},"SessionDetails":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0},"first":{"type":"string","format":"date-time","nullable":true},"last":{"type":"string","format":"date-time","nullable":true}},"required":["token_session","alias","active"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/sessions/{token_session}":{"get":{"tags":["Sessions"],"summary":"Get session by token","description":"Requires `READ` or `READ_WRITE` api key access type.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionGetResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## List sessions by device > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Sessions"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"SessionsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SessionSummary"}}},"required":["description"]}},"required":["body"]},"SessionSummary":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0}},"required":["token_session","alias","active"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/sessions/device/{deviceid}":{"get":{"tags":["Sessions"],"summary":"List sessions by device","description":"Requires `READ` or `READ_WRITE` api key access type.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionsListResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Get active session for device > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Sessions"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"SessionsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SessionSummary"}}},"required":["description"]}},"required":["body"]},"SessionSummary":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0}},"required":["token_session","alias","active"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/sessions/device/{deviceid}/active":{"get":{"tags":["Sessions"],"summary":"Get active session for device","description":"Requires `READ` or `READ_WRITE` api key access type.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionsListResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Close session > Requires \`WRITE\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Sessions"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"CloseSessionResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"token_session":{"type":"string"}},"required":["description","token_session"]}},"required":["body"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/sessions/close/{token_session}":{"patch":{"tags":["Sessions"],"summary":"Close session","description":"Requires `WRITE` or `READ_WRITE` api key access type.","responses":{"200":{"description":"Session closed succesfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseSessionResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` # Passings ## Insert passings > Requires \`WRITE\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Passings"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"InsertPassingsRequest":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"passings_list":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Passing"}}},"required":["token_session","passings_list"]},"Passing":{"type":"object","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time"},"num_passing":{"type":"integer","minimum":0},"bib":{"type":"string"},"participant_id":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"status":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}},"required":["timestamp","num_passing","bib"]},"InsertPassingsResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"token_session":{"type":"string"},"inserted_count":{"type":"integer","minimum":0},"duplicate_count":{"type":"integer","minimum":0}},"required":["description","token_session"]}},"required":["body"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"PayloadTooLarge":{"description":"Payload too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/passings":{"post":{"tags":["Passings"],"summary":"Insert passings","description":"Requires `WRITE` or `READ_WRITE` api key access type.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsertPassingsRequest"}}}},"responses":{"201":{"description":"Passings inserted succesfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsertPassingsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Get session passings > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Passings"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"parameters":{"First":{"name":"first","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":-1},"description":"First num_passing to include (inclusive). Use -1 to ignore."},"Last":{"name":"last","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":-1},"description":"Last num_passing to include (inclusive). Use -1 to ignore."},"PageZeroBased":{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0},"description":"0 disables paging. When > 0, behaves like 1-based page."}},"schemas":{"PassingsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Passing"}}},"required":["description"]}},"required":["body"]},"Passing":{"type":"object","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time"},"num_passing":{"type":"integer","minimum":0},"bib":{"type":"string"},"participant_id":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"status":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}},"required":["timestamp","num_passing","bib"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/passings/session/{token_session}":{"get":{"tags":["Passings"],"summary":"Get session passings","description":"Requires `READ` or `READ_WRITE` api key access type.","parameters":[{"$ref":"#/components/parameters/First"},{"$ref":"#/components/parameters/Last"},{"$ref":"#/components/parameters/PageZeroBased"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassingsListResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Get device passings > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Passings"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"parameters":{"From":{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Filter passings with timestamp >= from."},"To":{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Filter passings with timestamp <= to."},"PageZeroBased":{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0},"description":"0 disables paging. When > 0, behaves like 1-based page."}},"schemas":{"PassingsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Passing"}}},"required":["description"]}},"required":["body"]},"Passing":{"type":"object","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time"},"num_passing":{"type":"integer","minimum":0},"bib":{"type":"string"},"participant_id":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"status":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}},"required":["timestamp","num_passing","bib"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/passings/device/{deviceid}":{"get":{"tags":["Passings"],"summary":"Get device passings","description":"Requires `READ` or `READ_WRITE` api key access type.","parameters":[{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/To"},{"$ref":"#/components/parameters/PageZeroBased"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassingsListResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` # Events ## List events > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Events"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"parameters":{"Page":{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"1-based page."},"LimitEvents":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000},"description":"Max items per page (events)."}},"schemas":{"EventsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/EventSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["description","result","pagination"]}},"required":["body"]},"EventSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"name":{"type":"string","nullable":true},"edition":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true}},"required":["event_token"]},"Pagination":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1},"limit":{"type":"integer","minimum":1},"total":{"type":"integer","minimum":0},"has_more":{"type":"boolean"}},"required":["page","limit","total","has_more"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/events":{"get":{"tags":["Events"],"summary":"List events","description":"Requires `READ` or `READ_WRITE` api key access type.","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/LimitEvents"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsListResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Get event by token > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Events"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"EventGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","properties":{"description":{"type":"string"},"result":{"type":"object","description":"Event details (fields follow RRM schema; large object).","additionalProperties":true}},"required":["description"]}},"required":["body"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/events/{event_token}":{"get":{"tags":["Events"],"summary":"Get event by token","description":"Requires `READ` or `READ_WRITE` api key access type.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGetResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## List participants by event > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Events"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"parameters":{"Page":{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"1-based page."},"LimitParticipants":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000},"description":"Max items per page (participants)."},"ParticipantBib":{"name":"bib","in":"query","required":false,"schema":{"type":"string"},"description":"Filter participants by bib."},"ParticipantChip":{"name":"chip","in":"query","required":false,"schema":{"type":"string"},"description":"Filter participants by chip."},"ParticipantRaceToken":{"name":"race_token","in":"query","required":false,"schema":{"type":"string"},"description":"Filter participants by race_token."},"ParticipantStatus":{"name":"status","in":"query","required":false,"schema":{"type":"string"},"description":"Filter participants by status."}},"schemas":{"ParticipantsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["description","result","pagination"]}},"required":["body"]},"ParticipantSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"participant_token":{"type":"string"},"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true}},"required":["event_token","participant_token","name"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]},"Pagination":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1},"limit":{"type":"integer","minimum":1},"total":{"type":"integer","minimum":0},"has_more":{"type":"boolean"}},"required":["page","limit","total","has_more"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/events/{event_token}/participants":{"get":{"tags":["Events"],"summary":"List participants by event","description":"Requires `READ` or `READ_WRITE` api key access type.","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/LimitParticipants"},{"$ref":"#/components/parameters/ParticipantBib"},{"$ref":"#/components/parameters/ParticipantChip"},{"$ref":"#/components/parameters/ParticipantRaceToken"},{"$ref":"#/components/parameters/ParticipantStatus"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantsListResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Create participant > Requires \`WRITE\` or \`READ\_WRITE\` api key access type.\ > \ > Participant corrections (PATCH/DELETE) are intentionally not exposed in the public API.
```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Events"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"CreateParticipantRequest":{"allOf":[{"$ref":"#/components/schemas/Participant"}]},"Participant":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true,"description":"HH:mm:ss"}},"required":["name","bib"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]},"CreateParticipantResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"event_token":{"type":"string"},"participant_token":{"type":"string"},"result":{"type":"object","additionalProperties":true}},"required":["description","event_token","participant_token"]}},"required":["body"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"PayloadTooLarge":{"description":"Payload too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/events/{event_token}/participants":{"post":{"tags":["Events"],"summary":"Create participant","description":"Requires `WRITE` or `READ_WRITE` api key access type.\n\nParticipant corrections (PATCH/DELETE) are intentionally not exposed in the public API.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateParticipantRequest"}}}},"responses":{"201":{"description":"Participant inserted succesfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateParticipantResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"description":"Forbidden (includes plan enforcement)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflict (duplicate bib/chip/participant)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` ## Get participant by token > Requires \`READ\` or \`READ\_WRITE\` api key access type. ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"tags":[{"name":"Events"}],"servers":[{"url":"https://api.runonrufus.com/v0","description":"Production (v0)"}],"security":[{"ApiKeyHeader":[]},{"XApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication."},"XApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication (alternate header)."}},"schemas":{"ParticipantGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"$ref":"#/components/schemas/ParticipantSummary"}},"required":["description","result"]}},"required":["body"]},"ParticipantSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"participant_token":{"type":"string"},"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true}},"required":["event_token","participant_token","name"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]},"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}},"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}},"responses":{"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeAny"}}}},"InternalError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeNull"}}}}}},"paths":{"/events/{event_token}/participants/{participant_token}":{"get":{"tags":["Events"],"summary":"Get participant by token","description":"Requires `READ` or `READ_WRITE` api key access type.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantGetResponse"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}}}} ``` # Models ## The EnvelopeAny object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"EnvelopeAny":{"type":"object","additionalProperties":false,"properties":{"body":{"description":"Operation result body."}}}}}} ``` ## The EnvelopeNull object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"EnvelopeNull":{"type":"object","additionalProperties":false,"properties":{"body":{"nullable":true}},"required":["body"]}}}} ``` ## The Pagination object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"Pagination":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1},"limit":{"type":"integer","minimum":1},"total":{"type":"integer","minimum":0},"has_more":{"type":"boolean"}},"required":["page","limit","total","has_more"]}}}} ``` ## The DeviceSummary object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"DeviceSummary":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"type":{"type":"string"},"model":{"type":"string"},"alias":{"type":"string"},"firmware":{"type":"string","nullable":true},"serial_number":{"type":"string"},"last_login":{"type":"string","format":"date-time","nullable":true},"creation_date":{"type":"string","format":"date-time","nullable":true},"sessions":{"type":"integer","minimum":0},"device_status":{"type":"string","nullable":true},"battery_percentage":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"charging":{"type":"boolean","nullable":true},"last_telemetry_at":{"type":"string","format":"date-time","nullable":true},"last_reported_latitude":{"type":"number","nullable":true},"last_reported_longitude":{"type":"number","nullable":true}},"required":["deviceid","type","model","alias","serial_number"]}}}} ``` ## The DeviceDetails object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"DeviceDetails":{"allOf":[{"$ref":"#/components/schemas/DeviceSummary"},{"type":"object","additionalProperties":false,"properties":{"passings":{"type":"integer","minimum":0},"last_seen":{"type":"string","format":"date-time","nullable":true},"battery_volts":{"type":"number","nullable":true},"temperature_celsius":{"type":"integer","nullable":true},"gps_accuracy_m":{"type":"number","nullable":true},"network_type":{"type":"string","nullable":true},"signal_strength":{"type":"integer","nullable":true}}}]},"DeviceSummary":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"type":{"type":"string"},"model":{"type":"string"},"alias":{"type":"string"},"firmware":{"type":"string","nullable":true},"serial_number":{"type":"string"},"last_login":{"type":"string","format":"date-time","nullable":true},"creation_date":{"type":"string","format":"date-time","nullable":true},"sessions":{"type":"integer","minimum":0},"device_status":{"type":"string","nullable":true},"battery_percentage":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"charging":{"type":"boolean","nullable":true},"last_telemetry_at":{"type":"string","format":"date-time","nullable":true},"last_reported_latitude":{"type":"number","nullable":true},"last_reported_longitude":{"type":"number","nullable":true}},"required":["deviceid","type","model","alias","serial_number"]}}}} ``` ## The BindDeviceRequest object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"BindDeviceRequest":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"model":{"type":"string"},"serial_number":{"type":"string"},"alias":{"type":"string"},"firmware":{"type":"string"}},"required":["type","model","serial_number"]}}}} ``` ## The BindDeviceResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"BindDeviceResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"deviceid":{"type":"string"},"already_binded":{"type":"boolean","nullable":true}},"required":["description","deviceid"]}},"required":["body"]}}}} ``` ## The UnbindDeviceResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"UnbindDeviceResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"deviceid":{"type":"string"}},"required":["description","deviceid"]}},"required":["body"]}}}} ``` ## The DevicesListResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"DevicesListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["description","pagination"]}},"required":["body"]},"DeviceSummary":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"type":{"type":"string"},"model":{"type":"string"},"alias":{"type":"string"},"firmware":{"type":"string","nullable":true},"serial_number":{"type":"string"},"last_login":{"type":"string","format":"date-time","nullable":true},"creation_date":{"type":"string","format":"date-time","nullable":true},"sessions":{"type":"integer","minimum":0},"device_status":{"type":"string","nullable":true},"battery_percentage":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"charging":{"type":"boolean","nullable":true},"last_telemetry_at":{"type":"string","format":"date-time","nullable":true},"last_reported_latitude":{"type":"number","nullable":true},"last_reported_longitude":{"type":"number","nullable":true}},"required":["deviceid","type","model","alias","serial_number"]},"Pagination":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1},"limit":{"type":"integer","minimum":1},"total":{"type":"integer","minimum":0},"has_more":{"type":"boolean"}},"required":["page","limit","total","has_more"]}}}} ``` ## The DeviceGetResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"DeviceGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceDetails"}},"required":["description"]}},"required":["body"]},"DeviceDetails":{"allOf":[{"$ref":"#/components/schemas/DeviceSummary"},{"type":"object","additionalProperties":false,"properties":{"passings":{"type":"integer","minimum":0},"last_seen":{"type":"string","format":"date-time","nullable":true},"battery_volts":{"type":"number","nullable":true},"temperature_celsius":{"type":"integer","nullable":true},"gps_accuracy_m":{"type":"number","nullable":true},"network_type":{"type":"string","nullable":true},"signal_strength":{"type":"integer","nullable":true}}}]},"DeviceSummary":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"type":{"type":"string"},"model":{"type":"string"},"alias":{"type":"string"},"firmware":{"type":"string","nullable":true},"serial_number":{"type":"string"},"last_login":{"type":"string","format":"date-time","nullable":true},"creation_date":{"type":"string","format":"date-time","nullable":true},"sessions":{"type":"integer","minimum":0},"device_status":{"type":"string","nullable":true},"battery_percentage":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"charging":{"type":"boolean","nullable":true},"last_telemetry_at":{"type":"string","format":"date-time","nullable":true},"last_reported_latitude":{"type":"number","nullable":true},"last_reported_longitude":{"type":"number","nullable":true}},"required":["deviceid","type","model","alias","serial_number"]}}}} ``` ## The DeviceTelemetryRequest object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"DeviceTelemetryRequest":{"type":"object","additionalProperties":false,"description":"At least one telemetry field is required.","properties":{"reported_at":{"type":"string","format":"date-time"},"device_status":{"type":"string"},"battery_percentage":{"type":"integer","minimum":0,"maximum":100},"battery_volts":{"type":"number","minimum":0},"charging":{"type":"boolean"},"temperature_celsius":{"type":"integer","minimum":-100,"maximum":200},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"gps_accuracy_m":{"type":"number","minimum":0},"network_type":{"type":"string"},"signal_strength":{"type":"integer","minimum":-200,"maximum":200}}}}}} ``` ## The DeviceTelemetryResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"DeviceTelemetryResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"deviceid":{"type":"string"},"result":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"last_telemetry_at":{"type":"string","format":"date-time"},"device_status":{"type":"string","nullable":true},"battery_percentage":{"type":"integer","nullable":true},"battery_volts":{"type":"number","nullable":true},"charging":{"type":"boolean","nullable":true},"temperature_celsius":{"type":"integer","nullable":true},"last_reported_latitude":{"type":"number","nullable":true},"last_reported_longitude":{"type":"number","nullable":true},"gps_accuracy_m":{"type":"number","nullable":true},"network_type":{"type":"string","nullable":true},"signal_strength":{"type":"integer","nullable":true}}}},"required":["description","deviceid"]}},"required":["body"]}}}} ``` ## The CreateSessionRequest object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"CreateSessionRequest":{"type":"object","additionalProperties":false,"properties":{"deviceid":{"type":"string"},"alias":{"type":"string"}},"required":["deviceid"]}}}} ``` ## The CreateSessionResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"CreateSessionResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"token_session":{"type":"string"}},"required":["description","token_session"]}},"required":["body"]}}}} ``` ## The CloseSessionResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"CloseSessionResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"token_session":{"type":"string"}},"required":["description","token_session"]}},"required":["body"]}}}} ``` ## The SessionDetails object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"SessionDetails":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0},"first":{"type":"string","format":"date-time","nullable":true},"last":{"type":"string","format":"date-time","nullable":true}},"required":["token_session","alias","active"]}}}} ``` ## The SessionSummary object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"SessionSummary":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0}},"required":["token_session","alias","active"]}}}} ``` ## The SessionGetResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"SessionGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SessionDetails"}}},"required":["description"]}},"required":["body"]},"SessionDetails":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0},"first":{"type":"string","format":"date-time","nullable":true},"last":{"type":"string","format":"date-time","nullable":true}},"required":["token_session","alias","active"]}}}} ``` ## The SessionsListResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"SessionsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SessionSummary"}}},"required":["description"]}},"required":["body"]},"SessionSummary":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"alias":{"type":"string"},"creation_date":{"type":"string","format":"date-time"},"duration":{"type":"number","nullable":true},"active":{"type":"boolean"},"passings":{"type":"integer","minimum":0}},"required":["token_session","alias","active"]}}}} ``` ## The Passing object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"Passing":{"type":"object","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time"},"num_passing":{"type":"integer","minimum":0},"bib":{"type":"string"},"participant_id":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"status":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}},"required":["timestamp","num_passing","bib"]}}}} ``` ## The InsertPassingsRequest object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"InsertPassingsRequest":{"type":"object","additionalProperties":false,"properties":{"token_session":{"type":"string"},"passings_list":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Passing"}}},"required":["token_session","passings_list"]},"Passing":{"type":"object","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time"},"num_passing":{"type":"integer","minimum":0},"bib":{"type":"string"},"participant_id":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"status":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}},"required":["timestamp","num_passing","bib"]}}}} ``` ## The InsertPassingsResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"InsertPassingsResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"token_session":{"type":"string"},"inserted_count":{"type":"integer","minimum":0},"duplicate_count":{"type":"integer","minimum":0}},"required":["description","token_session"]}},"required":["body"]}}}} ``` ## The PassingsListResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"PassingsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Passing"}}},"required":["description"]}},"required":["body"]},"Passing":{"type":"object","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time"},"num_passing":{"type":"integer","minimum":0},"bib":{"type":"string"},"participant_id":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"status":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}},"required":["timestamp","num_passing","bib"]}}}} ``` ## The EventSummary object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"EventSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"name":{"type":"string","nullable":true},"edition":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true}},"required":["event_token"]}}}} ``` ## The EventsListResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"EventsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/EventSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["description","result","pagination"]}},"required":["body"]},"EventSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"name":{"type":"string","nullable":true},"edition":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true}},"required":["event_token"]},"Pagination":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1},"limit":{"type":"integer","minimum":1},"total":{"type":"integer","minimum":0},"has_more":{"type":"boolean"}},"required":["page","limit","total","has_more"]}}}} ``` ## The EventGetResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"EventGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","properties":{"description":{"type":"string"},"result":{"type":"object","description":"Event details (fields follow RRM schema; large object).","additionalProperties":true}},"required":["description"]}},"required":["body"]}}}} ``` ## The CustomField object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]}}}} ``` ## The Participant object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"Participant":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true,"description":"HH:mm:ss"}},"required":["name","bib"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]}}}} ``` ## The CreateParticipantRequest object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"CreateParticipantRequest":{"allOf":[{"$ref":"#/components/schemas/Participant"}]},"Participant":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true,"description":"HH:mm:ss"}},"required":["name","bib"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]}}}} ``` ## The ParticipantSummary object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"ParticipantSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"participant_token":{"type":"string"},"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true}},"required":["event_token","participant_token","name"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]}}}} ``` ## The ParticipantsListResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"ParticipantsListResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["description","result","pagination"]}},"required":["body"]},"ParticipantSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"participant_token":{"type":"string"},"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true}},"required":["event_token","participant_token","name"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]},"Pagination":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1},"limit":{"type":"integer","minimum":1},"total":{"type":"integer","minimum":0},"has_more":{"type":"boolean"}},"required":["page","limit","total","has_more"]}}}} ``` ## The ParticipantGetResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"ParticipantGetResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"result":{"$ref":"#/components/schemas/ParticipantSummary"}},"required":["description","result"]}},"required":["body"]},"ParticipantSummary":{"type":"object","additionalProperties":false,"properties":{"event_token":{"type":"string"},"participant_token":{"type":"string"},"name":{"type":"string"},"lastname":{"type":"string","nullable":true},"bib":{"type":"string","nullable":true},"chip":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"yob":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"age_group":{"type":"string","nullable":true},"team":{"type":"string","nullable":true},"club":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"telephone":{"type":"string","nullable":true},"group_id":{"type":"string","nullable":true},"race_token":{"type":"string","nullable":true},"custom_fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomField"}},"individual_start_time":{"type":"string","nullable":true}},"required":["event_token","participant_token","name"]},"CustomField":{"type":"object","additionalProperties":false,"properties":{"field_name":{"type":"string"},"value":{"type":"string","nullable":true}},"required":["field_name","value"]}}}} ``` ## The CreateParticipantResponse object ```json {"openapi":"3.0.3","info":{"title":"RUFUS Public REST API","version":"0.1.0"},"components":{"schemas":{"CreateParticipantResponse":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"event_token":{"type":"string"},"participant_token":{"type":"string"},"result":{"type":"object","additionalProperties":true}},"required":["description","event_token","participant_token"]}},"required":["body"]}}}} ``` # Introduction to RUFUS Race Manager Welcome to **RUFUS Race Manager**—your comprehensive, cloud-based solution for race timing and event management. Designed for both professional timers and event organizers, RUFUS Race Manager (RRM) streamlines every aspect of your race events, from registration to results, ensuring a seamless experience for you and your participants.
Race Dashboard in Map View in RUFUS Race Manager
Race Podiums Report in RUFUS Race Manager
Results View
Main Workspace Area
Event Structure Diagram
Event Select
New Event Modal
Events List
Event Settings
Event Control View
Race Notification Widget
Attached Full-Collapsed Widget
Attached Expanded Widget
Attached Collapsed Widget
Floating Collapsed Widget
Floating Expanded Widget
Participants Menu
Add Participant Dialog
Import Participants Step 1
Import Participants Step 2
| Participant Field | Recognized Column Headers |
|---|---|
| Bib Number | bib, race number, bibnumber, dorsal, number |
| Chip Code | chip, tag, rfid, transponder |
| Name | name, firstname, first name |
| Lastname | lastname, last name, surname, family name |
| Gender | gender, sex |
| Date of Birth (DOB) | dob, dateofbirth, date of birth, birthdate, birth date, fechadenacimiento, bdate |
| Year of Birth (YOB) | yob, yearofbirth, year of birth, birthyear, birth year |
| Age Group | agegroup, age group, categoria, category |
| Group | group, group id |
| Individual Start Time | start, start time, individualstarttime, starttime |
| Country | country, nation, nationality, nat, countrycode, country code |
| City | city, town, ciudad |
| Team | team, equipo |
| Club | club |
| email, mail | |
| Telephone | telephone, phone, phone number |
| Race | race, race name, course, carrera, evento, event |
Import Participants Step 3
Edit Participant View
Participant Status Selector
| Status | Description |
|---|---|
| NOT_STARTED | The participant has not yet started the race. |
| IN_RACE | The participant has started the race but has not yet finished. |
| FINISH | The participant has completed the race. |
| DNS | Did Not Start – the participant did not start the race. |
| DNF | Did Not Finish – the participant started but did not finish. |
| DSQ | Disqualified – the participant has been disqualified. |
| DNQ | Did Not Qualify – the participant did not qualify for the race. |
| Status | Condition |
|---|---|
| NOT_STARTED | No passings have been recorded for the participant. |
| IN_RACE | One or more passings exist but the final finish passing has not yet occurred. |
| FINISH | A valid finish passing has been recorded (lap ID 9999). |
| Status | Usage |
|---|---|
| DNS | Participant did not start the race. |
| DNF | Participant started but did not finish. |
| DSQ | Participant was disqualified. |
| DNQ | Participant did not qualify for the race. |
Participant note/reason & Penalty & Bonus box
Participant Passings
Add New Passing Modal for Laps races
Add New Passing Modal for Classical races
Participant Rankings
Participant Laps Grid
Participant Segments Grid
Participants View
Publish Participants List to Cloud Button
Edit Participant View
Bib Chip Swap
Time Swap
Checkpoint Plans
Checkpoint Promotion Diagram
Checkpoints Menu
Checkpoint Dialog
Bounce Time Diagram
Checkpoint Dashboard View
Checkpoint Active Diagram
Checkpoint-Race View
Checkpoint-Race View Passings Diagram
Races Menu List
| Race Type | Description |
|---|---|
| CLASSICAL | Traditional race format with an optional START checkpoint and a required FINISH checkpoint. Intermediate checkpoints can be added along the course. |
| LAPS | Lap-based races such as circuits or multi-loop formats. |
Classical Race Dialog
Race Structure Diagram
Review Generated Segments Dialog
Course Designer View