aboutGet
Retrieve basic information from your BirdDog device
/about
Usage and SDK Samples
curl -X GET\
-H "Accept: text"\
"http://192.168.2.197:8080/about?FirmwareVersion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BasicDeviceInformationApi;
import java.io.File;
import java.util.*;
public class BasicDeviceInformationApiExample {
public static void main(String[] args) {
BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
Object firmwareVersion = ; // Object | Device manufactuer `BIRDDOG`
Object format = ; // Object | Device manufacturer extended `BIRDDOG`
Object hostName = ; // Object | Hardware Revision `1.0`
Object iPAddress = ; // Object | Device IP Address `xxx.xxx.xxx.xxx`
Object networkConfigMethod = ; // Object | IP Address method `DHCP` `STATIC`
Object serialNumber = ; // Object | Device Hostname (AVAHI) `birddog-nnnnn`
Object status = ; // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
try {
apiInstance.aboutGet(firmwareVersion, format, hostName, iPAddress, networkConfigMethod, serialNumber, status);
} catch (ApiException e) {
System.err.println("Exception when calling BasicDeviceInformationApi#aboutGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.BasicDeviceInformationApi;
public class BasicDeviceInformationApiExample {
public static void main(String[] args) {
BasicDeviceInformationApi apiInstance = new BasicDeviceInformationApi();
Object firmwareVersion = ; // Object | Device manufactuer `BIRDDOG`
Object format = ; // Object | Device manufacturer extended `BIRDDOG`
Object hostName = ; // Object | Hardware Revision `1.0`
Object iPAddress = ; // Object | Device IP Address `xxx.xxx.xxx.xxx`
Object networkConfigMethod = ; // Object | IP Address method `DHCP` `STATIC`
Object serialNumber = ; // Object | Device Hostname (AVAHI) `birddog-nnnnn`
Object status = ; // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
try {
apiInstance.aboutGet(firmwareVersion, format, hostName, iPAddress, networkConfigMethod, serialNumber, status);
} catch (ApiException e) {
System.err.println("Exception when calling BasicDeviceInformationApi#aboutGet");
e.printStackTrace();
}
}
}
Object *firmwareVersion = ; // Device manufactuer `BIRDDOG` (optional)
Object *format = ; // Device manufacturer extended `BIRDDOG` (optional)
Object *hostName = ; // Hardware Revision `1.0` (optional)
Object *iPAddress = ; // Device IP Address `xxx.xxx.xxx.xxx` (optional)
Object *networkConfigMethod = ; // IP Address method `DHCP` `STATIC` (optional)
Object *serialNumber = ; // Device Hostname (AVAHI) `birddog-nnnnn` (optional)
Object *status = ; // Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO` (optional)
BasicDeviceInformationApi *apiInstance = [[BasicDeviceInformationApi alloc] init];
// Retrieve basic information from your BirdDog device
[apiInstance aboutGetWith:firmwareVersion
format:format
hostName:hostName
iPAddress:iPAddress
networkConfigMethod:networkConfigMethod
serialNumber:serialNumber
status:status
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
console.log(this.responseText);
}
};
xhttp.open("GET", "http://192.168.2.197:8080/about", true);
xhttp.send();
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class aboutGetExample
{
public void main()
{
var apiInstance = new BasicDeviceInformationApi();
var firmwareVersion = new Object(); // Object | Device manufactuer `BIRDDOG` (optional)
var format = new Object(); // Object | Device manufacturer extended `BIRDDOG` (optional)
var hostName = new Object(); // Object | Hardware Revision `1.0` (optional)
var iPAddress = new Object(); // Object | Device IP Address `xxx.xxx.xxx.xxx` (optional)
var networkConfigMethod = new Object(); // Object | IP Address method `DHCP` `STATIC` (optional)
var serialNumber = new Object(); // Object | Device Hostname (AVAHI) `birddog-nnnnn` (optional)
var status = new Object(); // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO` (optional)
try
{
// Retrieve basic information from your BirdDog device
apiInstance.aboutGet(firmwareVersion, format, hostName, iPAddress, networkConfigMethod, serialNumber, status);
}
catch (Exception e)
{
Debug.Print("Exception when calling BasicDeviceInformationApi.aboutGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiBasicDeviceInformationApi();
$firmwareVersion = ; // Object | Device manufactuer `BIRDDOG`
$format = ; // Object | Device manufacturer extended `BIRDDOG`
$hostName = ; // Object | Hardware Revision `1.0`
$iPAddress = ; // Object | Device IP Address `xxx.xxx.xxx.xxx`
$networkConfigMethod = ; // Object | IP Address method `DHCP` `STATIC`
$serialNumber = ; // Object | Device Hostname (AVAHI) `birddog-nnnnn`
$status = ; // Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
try {
$api_instance->aboutGet($firmwareVersion, $format, $hostName, $iPAddress, $networkConfigMethod, $serialNumber, $status);
} catch (Exception $e) {
echo 'Exception when calling BasicDeviceInformationApi->aboutGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BasicDeviceInformationApi;
my $api_instance = WWW::SwaggerClient::BasicDeviceInformationApi->new();
my $firmwareVersion = ; # Object | Device manufactuer `BIRDDOG`
my $format = ; # Object | Device manufacturer extended `BIRDDOG`
my $hostName = ; # Object | Hardware Revision `1.0`
my $iPAddress = ; # Object | Device IP Address `xxx.xxx.xxx.xxx`
my $networkConfigMethod = ; # Object | IP Address method `DHCP` `STATIC`
my $serialNumber = ; # Object | Device Hostname (AVAHI) `birddog-nnnnn`
my $status = ; # Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
eval {
$api_instance->aboutGet(firmwareVersion => $firmwareVersion, format => $format, hostName => $hostName, iPAddress => $iPAddress, networkConfigMethod => $networkConfigMethod, serialNumber => $serialNumber, status => $status);
};
if ($@) {
warn "Exception when calling BasicDeviceInformationApi->aboutGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.BasicDeviceInformationApi()
firmwareVersion = # Object | Device manufactuer `BIRDDOG` (optional)
format = # Object | Device manufacturer extended `BIRDDOG` (optional)
hostName = # Object | Hardware Revision `1.0` (optional)
iPAddress = # Object | Device IP Address `xxx.xxx.xxx.xxx` (optional)
networkConfigMethod = # Object | IP Address method `DHCP` `STATIC` (optional)
serialNumber = # Object | Device Hostname (AVAHI) `birddog-nnnnn` (optional)
status = # Object | Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO` (optional)
try:
# Retrieve basic information from your BirdDog device
api_instance.about_get(firmwareVersion=firmwareVersion, format=format, hostName=hostName, iPAddress=iPAddress, networkConfigMethod=networkConfigMethod, serialNumber=serialNumber, status=status)
except ApiException as e:
print("Exception when calling BasicDeviceInformationApi->aboutGet: %s\n" % e)
Parameters
Name | Description |
---|---|
Format |
Object
(string)
Device manufacturer extended `BIRDDOG`
|
HostName |
Object
(string)
Hardware Revision `1.0`
|
IPAddress |
Object
(string)
Device IP Address `xxx.xxx.xxx.xxx`
|
NetworkConfigMethod |
Object
(string)
IP Address method `DHCP` `STATIC`
|
SerialNumber |
Object
(string)
Device Hostname (AVAHI) `birddog-nnnnn`
|
Status |
Object
(string)
Current device status `ONLINE` `OFFLINE` `CAMERA INITIALIZING` `NO VIDEO`
|
Name | Description |
---|---|
FirmwareVersion |
Object
(string)
Device manufactuer `BIRDDOG`
|
Responses
Status: default - Device standard response
Example data
{"FirmwareVersion":"BirdDog Firmware version","Format":"CAM 1","HostName":"birddog-device","IPAddress":"192.168.100.100","NetworkConfigMethod":"dhcp","NetworkMask":"255.255.255.0","SerialNumber":"0123456789","Status":"active"}