Update README.md

master
cat6e 4 years ago committed by GitHub
parent 0498591e4a
commit e690a2ad27

@ -16,6 +16,8 @@ Planned:
API Server running on Port `3000` API Server running on Port `3000`
API Calls: API Calls:
@ -24,6 +26,51 @@ API Calls:
| GET `/api/message/status/<id>` - fetches the current Message Data(DeliveryLog, Payload, etc.) | GET `/api/message/status/<id>` - fetches the current Message Data(DeliveryLog, Payload, etc.)
| GET `/api/device/:` - Lists all Device IDs
| GET `/api/device/<DeviceType>:<ID>` - Returns the Device State.
Example:
> /api/device/birdyslim:test333
```json
{
"lastSeen": "2021-03-30T10:01:24.988Z",
"rssi": 34,
"lastLoRaPacket": {
"end_device_ids": {
"device_id": "test333",
"application_ids": {
"application_id": "birdy-slim-iot"
}
},
"correlation_ids": [ ... ],
"received_at": "2021-03-30T10:01:24.988088037Z",
"uplink_message": {
"f_port": 5,
"frm_payload": "AB4z1wBKLDEQ",
"decoded_payload": {
"lastGPSAcquisition": 16,
"latitude": 19.79351,
"longitude": 48.60977,
"type": "gps"
},
"settings": {
"data_rate": {}
},
"received_at": "0001-01-01T00:00:00Z"
},
"simulated": true
},
"gps": {
"gps": {
"lastGPSAcquisition": 16,
"latitude": 19.79351,
"longitude": 48.60977
}
}
}
```
| POST `/api/message/advanced` - Creates a new Message and starts delivering it, returns the Message ID. HTTP Body is a JSON Object. for example: | POST `/api/message/advanced` - Creates a new Message and starts delivering it, returns the Message ID. HTTP Body is a JSON Object. for example:
```json ```json
{ {

Loading…
Cancel
Save