RoscoLive API v1.0
  1. User
RoscoLive API v1.0
  • Device
    • Get device list for multiple companies
      GET
    • Get current activity status of devices
      GET
  • Driver Scoring / Coaching
    • Get company event score weights
      GET
    • Update company event score weights
      POST
  • Event
    • Get company events
      GET
    • Request videos of an event
      PUT
    • Get events for a device
      GET
  • Fleet Configuration
    • Create new profile in a company
      POST
    • Get a company profile
      GET
  • Metadata
    • Get alerts and events of devices for company
      GET
  • Report
    • Get custom report data
      GET
    • Get all events report for company
      GET
    • Get event count summary report for company devices
      GET
    • Update custom report
      POST
    • Create custom report for user
      PUT
  • User
    • Get a user
      GET
    • Get own info
      GET
    • Get application notifications
      GET
    • SD card reformat reminder
      POST
    • Update notification by email
      POST
    • Get event / sms notification settings
      GET
  1. User

Get a user

GET
https://fleet.roscolive.com/api/v1.0/partners/users/{user_email}
usernotificationdata
Get an existing RoscoLive user by email. The current user can request any user for which they have view permissions, including their own user.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/users/?show_notifications'
Response Response Example
200 - User data without notification settings
{
    "meta": {
        "code": 200
    },
    "response": {
        "user": {
            "active": true,
            "aggr_notific_interval": null,
            "alert_camera_errors": null,
            "alert_camera_failure": false,
            "alert_critical_gsensor": false,
            "alert_dv_camera_failure": false,
            "alert_high_temperature": false,
            "alert_idling": false,
            "alert_inactive_vehicles": false,
            "alert_inactive_vehicles_time": 5,
            "alert_no_sd_card": null,
            "alert_sd_error": false,
            "alert_sensor": false,
            "alert_speed": false,
            "audit_notification": false,
            "company_audit_log": null,
            "company_data": {
                "data_limit": 0,
                "live_active": true,
                "storage_active": true,
                "trace_active": true
            },
            "company_driver_recognition": "manual",
            "company_id": 3,
            "company_name": "Acme Trucking, LLC",
            "company_reformat_reminder": 4,
            "company_token": "12345670",
            "company_type": "PARTNER",
            "confirmed_at": true,
            "created_timestamp": "Thu, 05 Nov 2020 13:35:32 GMT",
            "daily_new_cameras_notifs": null,
            "daily_recording_status_notifs": false,
            "data_overage_notification": null,
            "data_overage_notification_vehicle_limit": "10",
            "data_pool_usage": false,
            "data_pool_usage_frequency": "weekly",
            "data_pool_warning": false,
            "data_pool_warning_threshold": "75",
            "data_usage_notification": false,
            "data_usage_notification_vehicle_limit": "100",
            "device_high_data_usage": false,
            "device_high_data_usage_threshold_data_pool": 30,
            "email": "jon.doe@example.com",
            "eula_was_viewed": true,
            "event_breakdown": false,
            "first_name": "Jon",
            "flood_notification": false,
            "groups": [],
            "harshaccel": null,
            "harshbraking": null,
            "has_registered_sms": false,
            "high_speeding": null,
            "id": 4737,
            "installer_company_name": null,
            "is_fake": false,
            "last_login": "Wed, 24 Jul 2024 13:16:00 GMT",
            "last_name": "Doe",
            "low_speeding": null,
            "mecp_cert": false,
            "moderate_speeding": null,
            "phone_number": "12345678",
            "recent_activity": "Wed, 24 Jul 2024 17:38:35 GMT",
            "recording_status_notifs": false,
            "reformat_last_notifs": "Thu, 05 Nov 2020 13:35:33 GMT",
            "reformat_reminder": false,
            "release_viewed": "Thu, 28 Dec 2023 17:13:00 GMT",
            "roles": [
                "partner"
            ],
            "rosco_product_owned": null,
            "settings": {
                "inputsensor1_active": false,
                "inputsensor1_description": null,
                "inputsensor1_name": null,
                "inputsensor2_active": false,
                "inputsensor2_description": null,
                "inputsensor2_name": null,
                "inputsensor3_active": false,
                "inputsensor3_description": null,
                "inputsensor3_name": null,
                "inputsensor4_active": false,
                "inputsensor4_description": null,
                "inputsensor4_name": null,
                "latitude": null,
                "longitude": null,
                "time_zone": null,
                "zoom_level": 5
            },
            "severe_speeding": null,
            "speed_unit": "mph",
            "status": "used",
            "unidentified_drivers": false,
            "work_submission_report": null
        }
    },
    "result": "OK"
}

Request

Path Params
user_email
string <email>
required
RoscoLive user email to retrieve
Query Params
show_notifications
boolean 
optional
Return user notification settings when set to true
Body Params multipart/form-data
object {0}

Responses

🟢200valid get a user
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by server
response
object 
required
Contains response data
user
object (User schema) 
required
result
string 
required
"OK" if request successful, otherwise "Failed"
🟠404get a non existing user
🟠401Login Required
Modified at 2024-11-26 20:49:00
Previous
Create custom report for user
Next
Get own info
Built with