PUT api/Units/SetFlightMode?serialNumber={serialNumber}
Order or cancel flight mode for unit
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
serialNumber |
Serialnumber |
string |
Required |
Body Parameters
UnitFlightModeModelName | Description | Type | Additional information |
---|---|---|---|
SerialNumber |
Serialnumber |
string |
None. |
Enabled |
Flight mode enabled/disabled |
boolean |
None. |
StartTime |
Start date and time (UTC) for flight mode |
date |
Null values possible. |
EndTime |
End date and time (UTC) for flight mode |
date |
Null values possible. |
Status |
Current status of flight mode (read only) |
FlightModeStatusEnum |
None. |
ActiveHoursLeft |
Remaining hours of flight mode when active (read only) |
integer32 |
Null values possible. |
StatusText |
Text explanation of current status (read only) |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SerialNumber": "sample string 1", "Enabled": true, "StartTime": "2025-01-18T05:22:26.4562557+00:00", "EndTime": "2025-01-18T05:22:26.4562557+00:00", "Status": 0, "ActiveHoursLeft": null, "StatusText": "Disabled" }
application/xml, text/xml
Sample:
<UnitFlightModeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models"> <Enabled>true</Enabled> <EndTime>2025-01-18T05:22:26.4562557+00:00</EndTime> <SerialNumber>sample string 1</SerialNumber> <StartTime>2025-01-18T05:22:26.4562557+00:00</StartTime> <Status>Disabled</Status> </UnitFlightModeModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Order or cancel flight mode for unit
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |