Organisation

/organisations/tree 🧪

GET apiURL/organisations/tree

Get all organisations you have access to (tree view with childs).

200

{
  "data": [ // Array or parent organisations
    {
      "uuid": "8d303e2e-3fa2-11e6-a919-21ebcd67fa73", // Organisation UUID
      "name": "OOCAR", // Organisation Name
      "type": "owner", // Organisation type
      "created_at": "2017-05-23T00:00:00.000Z", // Organisation creation date
      "childs": [ // Array of childs organisations
        {
          "uuid": "7af251ba-3fa2-11e7-b119-62ebcb67de24", // Organisation UUID
          "name": "GARAGE DES PALMIERS", // Organisation Name
          "type": "dealership", // Organisation type
          "created_at": "2017-05-23T00:00:00.000Z", // Organisation creation date
          "childs": null // Array of childs organisations
        },
        {
          "uuid": "21a008a4-1fc1-13e7-a649-62edcb62ab57", // Organisation UUID
          "name": "ANGERS", // Organisation Name
          "type": "dealership", // Organisation type
          "created_at": "2017-05-23T00:00:00.000Z", // Organisation creation date
          "childs": null // Array of childs organisations
        }
      ]
    }
  ]
}

/organisations 🧪

GET apiURL/organisations

Get all organisations you have access to.

Query Parameters

Name	Type	Description
skip	number
filter	string
orderby	string
limit	number
fields	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data Array of Organisation

{
  "data": [
    {
      "uuid": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "type": "d",
      "name": "JUIGNÉ SUR LOIRE",
      "created_at": "2017-05-23T00:00:00.000Z",
      "updated_at": "0000-00-00 00:00:00"
    },
    {
      "uuid": "ca7a6dd0-e976-494e-96c1-133267679d16",
      "type": "d",
      "name": "ANGERS",
      "created_at": "2017-05-23T00:00:00.000Z",
      "updated_at": "0000-00-00 00:00:00"
    }
  ],
  "total": 2,
  "skip": 0,
  "limit": 20
}

/organisation/:uuid 🧪

GET apiURL/organisation/:uuid

Get an organisation by UUID.

Path Parameters

Name	Type	Description
uuid	string	Organisation UUID ex: ee4769f4-ee48-11e8-7eb2-f9801f1b8fd1

Query Parameters

Name	Type	Description
fields	string

200 An Organisation object.

{
  "uuid": "7af261ba-3fa2-11e7-b119-62ebcb67de24",
  "type": "o",
  "name": "ROCADE SUD",
  "created_at": "2017-05-23T00:00:00.000Z",
  "updated_at": "0000-00-00 00:00:00"
}

/:uuid/organisations 🧪

GET apiURL/organisation/:uuid/organisations

Get all child organisations of an organisation.

Path Parameters

Name	Type	Description
uuid	string	Organisation UUID ex: 7735a0fb-025b-4fb9-be9f-34d646d84c0f

Query Parameters

Name	Type	Description
skip	number
filter	string
orderby	string
limit	number
fields	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data: Array of Organisation

 {
  "data": [
    {
      "uuid": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "type": "d",
      "name": "JUIGNÉ SUR LOIRE",
      "created_at": "2017-05-23T00:00:00.000Z",
      "updated_at": "0000-00-00 00:00:00"
    },
    {
      "uuid": "ca7a6dd0-e976-494e-96c1-133267679d16",
      "type": "d",
      "name": "ANGERS",
      "created_at": "2017-05-23T00:00:00.000Z",
      "updated_at": "0000-00-00 00:00:00"
    }
  ],
  "total": 2,
  "skip": 0,
  "limit": 20
}

/:uuid/users 🧪

GET apiURL/organisation/:uuid/users

Get all users attached to an organisation.

Path Parameters

Name	Type	Description
uuid	string	Organisation UUID ex: ee4769f4-ee48-11e8-7eb2-f9801f1b8fd1

Query Parameters

Name	Type	Description
skip	number
filter	string
orderby	string
limit	number
fields	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data: Array of User

{
  "data": [
    {
      "uuid": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "fb_email": "F",
      "name": null,
      "email": "",
      "lang": "fr",
      "created_at": "2016-09-11T11:39:44.000Z",
      "status": null,
      "blacklisted": 0,
      "avg_score_trip": 45.2485,
      "avg_score_accel": 40.0238,
      "avg_score_decel": 47.2321,
      "avg_score_gears": 45.3333,
      "avg_score_soft": 48.9821,
      "app_version": "2.91 (591)",
      "device_type": "ANDROID",
      "device_platform": "SM-G955F",
      "os_version": "8.0.0",
      "phone_number": null,
      "uuid_organisation": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "uuid_org_entity": null
    }
  ],
  "total": 25,
  "skip": 0,
  "limit": 1
}

/:uuid/trips 🧪

GET apiURL/organisation/:uuid/trips

Get all trips made by users attached to an organisation.

Path Parameters

Name	Type	Description
uuid	string	Organisation UUID ex: ee4769f4-ee48-11e8-7eb2-f9801f1b8fd1

Query Parameters

Name	Type	Description
skip	number
filter	string
orderby	string
limit	number
fields	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data: Array of Trip

{
  "data": [
    {
      "uuid": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "tag": null,
      "lat_start": 47.467,
      "lng_start": -0.538158,
      "lat_end": 47.4743,
      "lng_end": -0.546779,
      "country_code": "FR",
      "lang": "fr",
      "address_start": "130 Rue de Paris, 49100 Angers",
      "address_end": "3 Rue de la gare, 49100 Angers",
      "time_start": "2016-09-11T14:31:02.000Z",
      "time_end": "2016-09-11T14:46:40.000Z",
      "weather_start": "{\"icon\":\"clear-night\",\"precipIntensity\":0,\"precipProbability\":0,\"temperature\":6.07,\"apparentTemperature\":3.47,\"dewPoint\":4.62,\"humidity\":0.9,\"windSpeed\":3.49,\"windBearing\":87,\"cloudCover\":0,\"pressure\":1023.16,\"ozone\":281.95}",
      "weather_end": "{\"icon\":\"clear-night\",\"precipIntensity\":0,\"precipProbability\":0,\"temperature\":6.07,\"apparentTemperature\":3.48,\"dewPoint\":3.19,\"humidity\":0.82,\"windSpeed\":3.48,\"windBearing\":87,\"cloudCover\":0,\"pressure\":1023.17,\"ozone\":281.88}",
      "duration_s": 938,
      "pct_night": 0,
      "idle_time_pct": 0.384861,
      "nb_stops": 14,
      "distance_m": 3374,
      "speed_avg_moving_kmh": 21.0579,
      "speed_avg_kmh": 12.9224,
      "speed_max_kmh": 53,
      "speed_deviation": 14.653,
      "rpm_max": 3164,
      "rpm_avg": 898.634,
      "rpm_avg_moving": 1367.73,
      "rpm_0_1500_pct": 0.76841,
      "rpm_1500_2000_pct": 0.171825,
      "rpm_2000_4000_pct": 0.0597652,
      "rpm_4000_6000_pct": 0,
      "rpm_6000_sup_pct": 0,
      "load_avg": 18.0367,
      "load_deviation": 20.604,
      "accel_min": 0.138889,
      "accel_max": 4.16667,
      "decel_min": -0.0925926,
      "decel_max": -3.33333,
      "rpm_avg_rpm_power_max": 0.341932,
      "rpm_avg_rpm_torque_max": 0.781558,
      "rpm_max_rpm_power_max": 0.791,
      "fuel_start_pct": null,
      "fuel_end_pct": null,
      "fuel_consumed_l": 0.266941,
      "fuel_avg_l100": 7.91261,
      "trip_cost_euro_e10_95": 0,
      "trip_cost_euro_sp95": 0,
      "trip_cost_euro_sp98": 0,
      "trip_cost_euro_diesel": 0.362239,
      "co2_g": null,
      "co2_g_manufacturer": 296.878,
      "speed_0_30_pct": 0.840085,
      "speed_30_50_pct": 0.15048,
      "speed_50_70_pct": 0.00960512,
      "speed_70_100_pct": 0,
      "speed_100_130_pct": 0,
      "speed_130_150_pct": 0,
      "speed_150_180_pct": 0,
      "speed_180_plus_pct": 0,
      "accel_decel_slow_pct": 0.84968,
      "gear_shifts": 65,
      "gears_used": 4,
      "gear_1_pct": 0.221748,
      "gear_2_pct": 0.204691,
      "gear_3_pct": 0.08742,
      "gear_4_pct": 0.0298507,
      "gear_5_pct": 0,
      "gear_6_pct": 0,
      "gear_7_pct": 0,
      "gear_8_pct": 0,
      "gear_9_pct": 0,
      "gear_10_pct": 0,
      "gear_11_pct": 0,
      "gear_12_pct": 0,
      "avg_rpm_shift_up_0_1": 1386.3,
      "avg_rpm_shift_up_1_2": 2138.46,
      "avg_rpm_shift_up_2_3": 2056.29,
      "avg_rpm_shift_up_3_4": 1698.33,
      "avg_rpm_shift_up_4_5": 0,
      "avg_rpm_shift_up_5_6": 0,
      "avg_rpm_shift_up_6_7": 0,
      "avg_rpm_shift_up_7_8": 0,
      "avg_rpm_shift_up_8_9": 0,
      "avg_rpm_shift_up_9_10": 0,
      "avg_rpm_shift_up_10_11": 0,
      "avg_rpm_shift_up_11_12": 0,
      "shift_up_norm": null,
      "steady_gear_norm": null,
      "artemis_class": 2,
      "road_type": "U",
      "car_class": "DS",
      "note_steady_gear": 0,
      "note_shift_up_gear": 0,
      "note_steady_gear2": null,
      "note_shift_up_gear2": null,
      "note_pke": 84,
      "note_pke_andrieu": 21,
      "note_engine_brake": 69,
      "note_rpm_sd_stopexcluded": 14,
      "note_load_sd_stopexcluded": 67,
      "note_rpa": 53,
      "note_rna": 53,
      "note_sai": null,
      "note_accel_avg": 32,
      "note_decel_avg": 31,
      "note_accel_sd": 35,
      "note_decel_sd": 46,
      "note_idle_time_norm": 32,
      "note_pct_accel_fast": null,
      "note_pct_decel_fast": null,
      "note_finale": 41.0833,
      "note_conso": 0,
      "stars_accel": 2,
      "stars_decel": 2.4875,
      "stars_gear": null,
      "stars_soft": 1.675,
      "similarity_to_do": 1,
      "status": "O",
      "discard": 0,
      "optimCDRA": 0,
      "device_memory": 0
    }
  ],
  "total": 933,
  "skip": 0,
  "limit": 1
}

/:uuid/vehicles 🧪

GET apiURL/organisation/:uuid/vehicles

Get all vehicles attached to an organisation.

Path Parameters

Name	Type	Description
uuid	string	Organisation UUID ex: ee4769f4-ee48-11e8-7eb2-f9801f1b8fd1

Query Parameters

Name	Type	Description
skip	number
filter	string
orderby	string
limit	number
fields	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data: Array of Vehicle

{
  "data": [
    {
      "uuid": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "id_autodata": "PEU28261",
      "latitude": 43.141882,
      "longitude": -2.142031,
      "position_at": "2016-10-27T17:12:02.000Z",
      "created_at": "2017-06-29T00:00:00.000Z",
      "mileage": 316869,
      "mileage_oocar": 316869,
      "oil": null,
      "capacity": null,
      "fuel": null,
      "tank": null,
      "state": "S",
      "removed": 0,
      "protocole": null,
      "mileage_auto": 0,
      "mileage_source": null
    }
  ],
  "total": 40,
  "skip": 0,
  "limit": 1
}

/:uuid/devices 🧪

GET apiURL/organisation/:uuid/devices

Get all devices attached to an organisation.

Path Parameters

Name	Type	Description
uuid	string	Organisation UUID ex: ee4769f4-ee48-11e8-7eb2-f9801f1b8fd1

Query Parameters

Name	Type	Description
skip	number
filter	string
orderby	string
limit	number
fields	string

200 - total: Number - skip: Number - limit: Number - orderby: Array of String - data: Array of Device

{
  "data": [
    {
      "sku": "504030318F316530313735305757323044325409",
      "sku_220": "",
      "sku_ascii": "0001O55081508570D27008ML04",
      "sku_decimal": null,
      "version": "2",
      "name": "ML01",
      "ppcp": null,
      "service_changed": null,
      "system_id": null,
      "model_number": null,
      "serial_number": null,
      "firmware_revision": "2.21",
      "hardware_revision": "3.21",
      "software_revision": "2.12",
      "manufacturer_name": "smarto",
      "rcdt": null,
      "comment": null,
      "last_update_date": "2018-04-06T00:00:00.000Z",
      "faulty_at": null,
      "created_at": "2017-06-22T15:12:59.000Z",
      "bound_at": "2018-04-06T15:09:53.000Z",
      "uuid_org_owner": "3decaff6-1f67-4870-bb54-15ae3614acf4",
      "uuid_entity_owner": null,
      "uuid_org_fleet": null
    }
  ],
  "total": 50,
  "skip": 0,
  "limit": 1
}