Hiboo API
Get your API keysLogin
  • Guides
    • Welcome 馃嚞馃嚙
    • Bienvenue 馃嚝馃嚪
    • Quick Start
    • FAQ
  • API Reference
    • Connect
    • Equipment Data
    • Equipment Document
Powered by GitBook
On this page
  1. API Reference

Connect

PreviousFAQNextEquipment Data

Last updated 7 months ago

Dive into the specifics of each API endpoint by checking out our complete documentation.

You will find all the methods associated with CRUDing some data sharing. Which isn't as weird as it sounds:

List Sharing

get

Returns all Sharing instances that have been created

Authorizations
Query parameters
offsetintegerRequired

The number of items to skip before starting to collect the result set

limitintegerRequired

The number of items to return

Responses
200
successful operation
application/json
400
Invalid input or missing parameters
application/json
401
The user is not authenticated
application/json
get
GET /v2/fleet/sharings HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
{
  "reference": "contract-4242-2024",
  "startDate": "2025-06-04T01:32:01.468Z",
  "endDate": "2025-06-04T01:32:01.468Z",
  "dataPacksCodes": [
    [
      "essential",
      "vehicle_conditions",
      "energy_and_fuel",
      "activity",
      "others",
      "usage_hours",
      "fault_codes"
    ]
  ],
  "assetIds": [
    "1, 2, 3"
  ],
  "recipient": "john.doe@example.com",
  "notificationEnabled": true,
  "properties": {
    "customer": "Customer Name",
    "site": "Site Name",
    "contract": "XK-123456",
    "purchaseOrder": "0986-XX-60",
    "project": "ABC-123-ZX-456"
  }
}

Delete a Sharing

delete

It totally deletes a Sharing as it never existed.

Authorizations
Path parameters
referencestringRequired

The reference you defined when creating the Sharing

Example: contract-4242-2024
Responses
204
Sharing was successfully deleted
401
The user is not authenticated
application/json
403
The user does not have the right to delete a Sharing
application/json
404
Sharing not found
application/json
409
Sharing cannot be deleted because it has already started or ended
application/json
delete
DELETE /v2/fleet/sharings/{reference} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

No content

Stop the sharing

delete
Authorizations
Path parameters
referencestringRequired

The reference you defined when creating the Sharing

Example: contract-4242-2024
Responses
204
successful operation
401
The user is not authenticated
application/json
403
The user does not have the right to stop the Sharing
application/json
404
Sharing not found
application/json
409
if the Sharing is not in progress
application/json
delete
DELETE /v2/fleet/sharings/{reference}/in-progress HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

No content

  • POSTCreate a new Sharing
  • PATCHUpdate an existing sharing
  • GETList Sharing
  • DELETEDelete a Sharing
  • DELETEStop the sharing

Create a new Sharing

post

This endpoint will allow you to create a new instance of Sharing. It can be a contract for instance.

Authorizations
Body
referencestringRequired

It can be a contract reference for instance

Example: contract-4242-2024
startDatestring 路 date-timeRequired

Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ).

endDatestring 路 date-timeOptional

Date when the sharing of data should stop serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

assetIdsnumber 路 int64[] 路 min: 1Required

All the equipment that you wish to share, use Hiboo's ids

Example: 1
recipientstring 路 emailRequired

Recipient's email address

Example: john.doe@example.com
notificationEnabledbooleanOptional

If false, the recipient will not be notified when the sharing is created or started

Responses
201
Successful operation
application/json
400
Invalid input or missing parameters
application/json
401
The user is not authenticated
application/json
403
The user does not have the right to create a Sharing
application/json
post
POST /v2/fleet/sharings HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 367

{
  "reference": "contract-4242-2024",
  "startDate": "2025-06-04T01:32:01.468Z",
  "endDate": "2025-06-04T01:32:01.468Z",
  "optionalDataPackCodes": [
    "fault_codes"
  ],
  "assetIds": [
    1
  ],
  "recipient": "john.doe@example.com",
  "notificationEnabled": true,
  "properties": {
    "customer": "Customer Name",
    "site": "Site Name",
    "contract": "XK-123456",
    "purchaseOrder": "0986-XX-60",
    "project": "ABC-123-ZX-456"
  }
}
{
  "reference": "contract-4242-2024",
  "startDate": "2025-06-04T01:32:01.468Z",
  "endDate": "2025-06-04T01:32:01.468Z",
  "dataPacksCodes": [
    [
      "essential",
      "vehicle_conditions",
      "energy_and_fuel",
      "activity",
      "others",
      "usage_hours",
      "fault_codes"
    ]
  ],
  "assetIds": [
    "1, 2, 3"
  ],
  "recipient": "john.doe@example.com",
  "notificationEnabled": true,
  "properties": {
    "customer": "Customer Name",
    "site": "Site Name",
    "contract": "XK-123456",
    "purchaseOrder": "0986-XX-60",
    "project": "ABC-123-ZX-456"
  }
}

Update an existing sharing

patch

Update an existing sharing by reference

Authorizations
Path parameters
referencestringRequired

The reference you defined when creating the Sharing

Example: contract-4242-2024
Body
referencestringOptional

It can be a contract reference for instance

Example: contract-4242-2024
startDatestring 路 date-timeOptional

Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ).

endDatestring 路 date-timeOptional

Date when the sharing of data should stop serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

Responses
200
Successful operation
application/json
400
Missing parameters or invalid parameters
application/json
401
The user is not authenticated
application/json
403
The user does not have the right to update the Sharing
application/json
404
Sharing not found
application/json
409
Sharing has already started
application/json
patch
PATCH /v2/fleet/sharings/{reference} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "reference": "contract-4242-2024",
  "startDate": "2025-06-04T01:32:01.468Z",
  "endDate": "2025-06-04T01:32:01.468Z",
  "optionalDataPackCodes": [
    "fault_codes"
  ],
  "properties": {
    "customer": "Customer Name",
    "site": "Site Name",
    "contract": "XK-123456",
    "purchaseOrder": "0986-XX-60",
    "project": "ABC-123-ZX-456"
  }
}
{
  "reference": "contract-4242-2024",
  "startDate": "2025-06-04T01:32:01.468Z",
  "endDate": "2025-06-04T01:32:01.468Z",
  "dataPacksCodes": [
    [
      "essential",
      "vehicle_conditions",
      "energy_and_fuel",
      "activity",
      "others",
      "usage_hours",
      "fault_codes"
    ]
  ],
  "assetIds": [
    "1, 2, 3"
  ],
  "recipient": "john.doe@example.com",
  "notificationEnabled": true,
  "properties": {
    "customer": "Customer Name",
    "site": "Site Name",
    "contract": "XK-123456",
    "purchaseOrder": "0986-XX-60",
    "project": "ABC-123-ZX-456"
  }
}