Skip to main content

Get batteries list

Retrieves all available batteries into the specified project

 GET /api/1.0/batteries?project={projectId}

Response

Model: application/json

ARRAY 
[
{
"id": <Integer> Battery id
"serialNumber": <String> The battery Serial number,
"generalComments": <String> Battery general comments,
"manufacturerId": <String> Battery tmanufacturer id
"status": <Integer> Battery status, //(-1: DELETED, 1: ACTIVE, 2: ARCHIVED)
"base": <Integer> Base id
"batteryType": <Integer> Battery type id
"firstUse": <String> Battery first usage registered
"totalFlightTime": <String> Total flight time for this battery (HH:mm:ss)
"totalNumberOfOperations": <Integer> Battery number of operations
"registrationDate": <String> Battery registration date
"kmFlown": <Float> Battery km flown (km)
}
]

Query parameters

Some parameters are allowed for a filtered response

caution

parameters with * are mandatory

* project: <Integer> - Get batteries for that project id
status: <String> - It will return batteries with the specified status id (-1 = Deleted, 0 = Active, 2 = Archived)

Example

const fetchData=async ()=>{
let j,response;
const serverResponse = await fetch(`https://cloud.rigi.tech/api/1.0/batteries?project=22&status=1`, {
mode: "cors",
method: "GET",
referrer: "no-referrer",
headers: {"authorization": "Bearer " + token}
})
if(!serverResponse.ok){
try {
switch (serverResponse.status){
case 400:
j = await serverResponse.json();
break;
case 403:
response = { message: "Forbidden access to data" };
case 404:
response = { message: "Address not found" };
default:
j = await serverResponse.json()
}
} catch (e) {
response = { message: "Error fetching data" };
}
}else{
j = await serverResponse.json()
}

response = { data:j };
const {data, message} = response
if(message) console.debug(message)
if(data) console.debug(data)
}
fetchData()

Answer:

[
{
"id": 11,
"serialNumber": "BAT-RT-0002",
"generalComments": "Testing battery.",
"manufacturerId": "",
"status": 1,
"base": 55,
"batteryType": 2,
"firstUse": "2021-11-24T08:50:50.000Z",
"totalFlightTime": "15:20:16",
"totalNumberOfOperations": 55,
"registrationDate": "2021-03-01T00:00:00.000Z",
"kmFlown": 2074.01
},
{
"id": 12,
"serialNumber": "BAT-RT-0001",
"generalComments": "Testing battery 2.",
"manufacturerId": "",
"status": 1,
"base": 55,
"batteryType": 2,
"firstUse": "2021-11-29T09:52:55.000Z",
"totalFlightTime": "01:47:14",
"totalNumberOfOperations": 4,
"registrationDate": "2021-03-01T00:00:00.000Z",
"kmFlown": 182.84
}
]