OpenAPI Sample

Api

apiJobsList

SatNOGS Network Job API view class


/api/jobs/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/jobs/?end=&ground_station=&id=&satellite__norad_cat_id=&start=&status=&transmitter_mode=&transmitter_type=&transmitter_uuid=&vetted_status=&vetted_user=&waterfall_status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer satelliteNoradCatId = 56; // Integer | 
        Date start = 2013-10-20T19:20:30+01:00; // Date | 
        String status = status_example; // String | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        String vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
        Integer vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
        Boolean waterfallStatus = true; // Boolean | 
        
        try {
            array[Job] result = apiInstance.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiJobsList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer satelliteNoradCatId = 56; // Integer | 
        Date start = 2013-10-20T19:20:30+01:00; // Date | 
        String status = status_example; // String | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        String vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
        Integer vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
        Boolean waterfallStatus = true; // Boolean | 
        
        try {
            array[Job] result = apiInstance.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiJobsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Date *end = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *groundStation = 56; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *satelliteNoradCatId = 56; //  (optional) (default to null)
Date *start = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
String *status = status_example; //  (optional) (default to null)
String *transmitterMode = transmitterMode_example; //  (optional) (default to null)
String *transmitterType = transmitterType_example; //  (optional) (default to null)
String *transmitterUuid = transmitterUuid_example; //  (optional) (default to null)
String *vettedStatus = vettedStatus_example; // Vetted status (deprecated: please use Status) (optional) (default to null)
Integer *vettedUser = 56; // Vetted user (deprecated: will be removed in next version) (optional) (default to null)
Boolean *waterfallStatus = true; //  (optional) (default to null)

[apiInstance apiJobsListWith:end
    groundStation:groundStation
    id:id
    satelliteNoradCatId:satelliteNoradCatId
    start:start
    status:status
    transmitterMode:transmitterMode
    transmitterType:transmitterType
    transmitterUuid:transmitterUuid
    vettedStatus:vettedStatus
    vettedUser:vettedUser
    waterfallStatus:waterfallStatus
              completionHandler: ^(array[Job] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var opts = {
  'end': 2013-10-20T19:20:30+01:00, // {Date} 
  'groundStation': 56, // {Integer} 
  'id': 56, // {Integer} 
  'satelliteNoradCatId': 56, // {Integer} 
  'start': 2013-10-20T19:20:30+01:00, // {Date} 
  'status': status_example, // {String} 
  'transmitterMode': transmitterMode_example, // {String} 
  'transmitterType': transmitterType_example, // {String} 
  'transmitterUuid': transmitterUuid_example, // {String} 
  'vettedStatus': vettedStatus_example, // {String} Vetted status (deprecated: please use Status)
  'vettedUser': 56, // {Integer} Vetted user (deprecated: will be removed in next version)
  'waterfallStatus': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiJobsList(opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiJobsListExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var end = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var groundStation = 56;  // Integer |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var satelliteNoradCatId = 56;  // Integer |  (optional)  (default to null)
            var start = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var status = status_example;  // String |  (optional)  (default to null)
            var transmitterMode = transmitterMode_example;  // String |  (optional)  (default to null)
            var transmitterType = transmitterType_example;  // String |  (optional)  (default to null)
            var transmitterUuid = transmitterUuid_example;  // String |  (optional)  (default to null)
            var vettedStatus = vettedStatus_example;  // String | Vetted status (deprecated: please use Status) (optional)  (default to null)
            var vettedUser = 56;  // Integer | Vetted user (deprecated: will be removed in next version) (optional)  (default to null)
            var waterfallStatus = true;  // Boolean |  (optional)  (default to null)

            try {
                array[Job] result = apiInstance.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiJobsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$end = 2013-10-20T19:20:30+01:00; // Date | 
$groundStation = 56; // Integer | 
$id = 56; // Integer | 
$satelliteNoradCatId = 56; // Integer | 
$start = 2013-10-20T19:20:30+01:00; // Date | 
$status = status_example; // String | 
$transmitterMode = transmitterMode_example; // String | 
$transmitterType = transmitterType_example; // String | 
$transmitterUuid = transmitterUuid_example; // String | 
$vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
$vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
$waterfallStatus = true; // Boolean | 

try {
    $result = $api_instance->apiJobsList($end, $groundStation, $id, $satelliteNoradCatId, $start, $status, $transmitterMode, $transmitterType, $transmitterUuid, $vettedStatus, $vettedUser, $waterfallStatus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiJobsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $end = 2013-10-20T19:20:30+01:00; # Date | 
my $groundStation = 56; # Integer | 
my $id = 56; # Integer | 
my $satelliteNoradCatId = 56; # Integer | 
my $start = 2013-10-20T19:20:30+01:00; # Date | 
my $status = status_example; # String | 
my $transmitterMode = transmitterMode_example; # String | 
my $transmitterType = transmitterType_example; # String | 
my $transmitterUuid = transmitterUuid_example; # String | 
my $vettedStatus = vettedStatus_example; # String | Vetted status (deprecated: please use Status)
my $vettedUser = 56; # Integer | Vetted user (deprecated: will be removed in next version)
my $waterfallStatus = true; # Boolean | 

eval { 
    my $result = $api_instance->apiJobsList(end => $end, groundStation => $groundStation, id => $id, satelliteNoradCatId => $satelliteNoradCatId, start => $start, status => $status, transmitterMode => $transmitterMode, transmitterType => $transmitterType, transmitterUuid => $transmitterUuid, vettedStatus => $vettedStatus, vettedUser => $vettedUser, waterfallStatus => $waterfallStatus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiJobsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
end = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
groundStation = 56 # Integer |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
satelliteNoradCatId = 56 # Integer |  (optional) (default to null)
start = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
status = status_example # String |  (optional) (default to null)
transmitterMode = transmitterMode_example # String |  (optional) (default to null)
transmitterType = transmitterType_example # String |  (optional) (default to null)
transmitterUuid = transmitterUuid_example # String |  (optional) (default to null)
vettedStatus = vettedStatus_example # String | Vetted status (deprecated: please use Status) (optional) (default to null)
vettedUser = 56 # Integer | Vetted user (deprecated: will be removed in next version) (optional) (default to null)
waterfallStatus = true # Boolean |  (optional) (default to null)

try: 
    api_response = api_instance.api_jobs_list(end=end, groundStation=groundStation, id=id, satelliteNoradCatId=satelliteNoradCatId, start=start, status=status, transmitterMode=transmitterMode, transmitterType=transmitterType, transmitterUuid=transmitterUuid, vettedStatus=vettedStatus, vettedUser=vettedUser, waterfallStatus=waterfallStatus)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiJobsList: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let end = 2013-10-20T19:20:30+01:00; // Date
    let groundStation = 56; // Integer
    let id = 56; // Integer
    let satelliteNoradCatId = 56; // Integer
    let start = 2013-10-20T19:20:30+01:00; // Date
    let status = status_example; // String
    let transmitterMode = transmitterMode_example; // String
    let transmitterType = transmitterType_example; // String
    let transmitterUuid = transmitterUuid_example; // String
    let vettedStatus = vettedStatus_example; // String
    let vettedUser = 56; // Integer
    let waterfallStatus = true; // Boolean

    let mut context = ApiApi::Context::default();
    let result = client.apiJobsList(end, groundStation, id, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
end
Date (date-time)
ground_station
Integer
id
Integer
satellite__norad_cat_id
Integer
start
Date (date-time)
status
String
transmitter_mode
String
transmitter_type
String
transmitter_uuid
String
vetted_status
String
Vetted status (deprecated: please use Status)
vetted_user
Integer
Vetted user (deprecated: will be removed in next version)
waterfall_status
Boolean

Responses


apiJobsRetrieve

SatNOGS Network Job API view class


/api/jobs/{id}/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/jobs/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        
        try {
            Job result = apiInstance.apiJobsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiJobsRetrieve");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        
        try {
            Job result = apiInstance.apiJobsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiJobsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)

[apiInstance apiJobsRetrieveWith:id
              completionHandler: ^(Job output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var id = 56; // {Integer} A unique integer value identifying this observation.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiJobsRetrieve(id, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiJobsRetrieveExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)

            try {
                Job result = apiInstance.apiJobsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiJobsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$id = 56; // Integer | A unique integer value identifying this observation.

try {
    $result = $api_instance->apiJobsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiJobsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.

eval { 
    my $result = $api_instance->apiJobsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiJobsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)

try: 
    api_response = api_instance.api_jobs_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiJobsRetrieve: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = ApiApi::Context::default();
    let result = client.apiJobsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this observation.
Required

Responses


apiObservationsCreate

Creates observations from a list of observation data


/api/observations/

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
 "http://localhost/api/observations/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        NewObservation newObservation = ; // NewObservation | 
        
        try {
            NewObservation result = apiInstance.apiObservationsCreate(newObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        NewObservation newObservation = ; // NewObservation | 
        
        try {
            NewObservation result = apiInstance.apiObservationsCreate(newObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
NewObservation *newObservation = ; // 

[apiInstance apiObservationsCreateWith:newObservation
              completionHandler: ^(NewObservation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var newObservation = ; // {NewObservation} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiObservationsCreate(newObservation, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiObservationsCreateExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var newObservation = new NewObservation(); // NewObservation | 

            try {
                NewObservation result = apiInstance.apiObservationsCreate(newObservation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiObservationsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$newObservation = ; // NewObservation | 

try {
    $result = $api_instance->apiObservationsCreate($newObservation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiObservationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $newObservation = WWW::OPenAPIClient::Object::NewObservation->new(); # NewObservation | 

eval { 
    my $result = $api_instance->apiObservationsCreate(newObservation => $newObservation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiObservationsCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
newObservation =  # NewObservation | 

try: 
    api_response = api_instance.api_observations_create(newObservation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiObservationsCreate: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let newObservation = ; // NewObservation

    let mut context = ApiApi::Context::default();
    let result = client.apiObservationsCreate(newObservation, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
newObservation *

Responses


apiObservationsList

SatNOGS Network Observation API view class


/api/observations/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/observations/?end=&ground_station=&id=&page=&satellite__norad_cat_id=&start=&status=&transmitter_mode=&transmitter_type=&transmitter_uuid=&vetted_status=&vetted_user=&waterfall_status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer page = 56; // Integer | A page number within the paginated result set.
        Integer satelliteNoradCatId = 56; // Integer | 
        Date start = 2013-10-20T19:20:30+01:00; // Date | 
        String status = status_example; // String | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        String vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
        Integer vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
        Boolean waterfallStatus = true; // Boolean | 
        
        try {
            PaginatedObservationList result = apiInstance.apiObservationsList(end, groundStation, id, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer page = 56; // Integer | A page number within the paginated result set.
        Integer satelliteNoradCatId = 56; // Integer | 
        Date start = 2013-10-20T19:20:30+01:00; // Date | 
        String status = status_example; // String | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        String vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
        Integer vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
        Boolean waterfallStatus = true; // Boolean | 
        
        try {
            PaginatedObservationList result = apiInstance.apiObservationsList(end, groundStation, id, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Date *end = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *groundStation = 56; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *page = 56; // A page number within the paginated result set. (optional) (default to null)
Integer *satelliteNoradCatId = 56; //  (optional) (default to null)
Date *start = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
String *status = status_example; //  (optional) (default to null)
String *transmitterMode = transmitterMode_example; //  (optional) (default to null)
String *transmitterType = transmitterType_example; //  (optional) (default to null)
String *transmitterUuid = transmitterUuid_example; //  (optional) (default to null)
String *vettedStatus = vettedStatus_example; // Vetted status (deprecated: please use Status) (optional) (default to null)
Integer *vettedUser = 56; // Vetted user (deprecated: will be removed in next version) (optional) (default to null)
Boolean *waterfallStatus = true; //  (optional) (default to null)

[apiInstance apiObservationsListWith:end
    groundStation:groundStation
    id:id
    page:page
    satelliteNoradCatId:satelliteNoradCatId
    start:start
    status:status
    transmitterMode:transmitterMode
    transmitterType:transmitterType
    transmitterUuid:transmitterUuid
    vettedStatus:vettedStatus
    vettedUser:vettedUser
    waterfallStatus:waterfallStatus
              completionHandler: ^(PaginatedObservationList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var opts = {
  'end': 2013-10-20T19:20:30+01:00, // {Date} 
  'groundStation': 56, // {Integer} 
  'id': 56, // {Integer} 
  'page': 56, // {Integer} A page number within the paginated result set.
  'satelliteNoradCatId': 56, // {Integer} 
  'start': 2013-10-20T19:20:30+01:00, // {Date} 
  'status': status_example, // {String} 
  'transmitterMode': transmitterMode_example, // {String} 
  'transmitterType': transmitterType_example, // {String} 
  'transmitterUuid': transmitterUuid_example, // {String} 
  'vettedStatus': vettedStatus_example, // {String} Vetted status (deprecated: please use Status)
  'vettedUser': 56, // {Integer} Vetted user (deprecated: will be removed in next version)
  'waterfallStatus': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiObservationsList(opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiObservationsListExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var end = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var groundStation = 56;  // Integer |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var page = 56;  // Integer | A page number within the paginated result set. (optional)  (default to null)
            var satelliteNoradCatId = 56;  // Integer |  (optional)  (default to null)
            var start = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var status = status_example;  // String |  (optional)  (default to null)
            var transmitterMode = transmitterMode_example;  // String |  (optional)  (default to null)
            var transmitterType = transmitterType_example;  // String |  (optional)  (default to null)
            var transmitterUuid = transmitterUuid_example;  // String |  (optional)  (default to null)
            var vettedStatus = vettedStatus_example;  // String | Vetted status (deprecated: please use Status) (optional)  (default to null)
            var vettedUser = 56;  // Integer | Vetted user (deprecated: will be removed in next version) (optional)  (default to null)
            var waterfallStatus = true;  // Boolean |  (optional)  (default to null)

            try {
                PaginatedObservationList result = apiInstance.apiObservationsList(end, groundStation, id, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiObservationsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$end = 2013-10-20T19:20:30+01:00; // Date | 
$groundStation = 56; // Integer | 
$id = 56; // Integer | 
$page = 56; // Integer | A page number within the paginated result set.
$satelliteNoradCatId = 56; // Integer | 
$start = 2013-10-20T19:20:30+01:00; // Date | 
$status = status_example; // String | 
$transmitterMode = transmitterMode_example; // String | 
$transmitterType = transmitterType_example; // String | 
$transmitterUuid = transmitterUuid_example; // String | 
$vettedStatus = vettedStatus_example; // String | Vetted status (deprecated: please use Status)
$vettedUser = 56; // Integer | Vetted user (deprecated: will be removed in next version)
$waterfallStatus = true; // Boolean | 

try {
    $result = $api_instance->apiObservationsList($end, $groundStation, $id, $page, $satelliteNoradCatId, $start, $status, $transmitterMode, $transmitterType, $transmitterUuid, $vettedStatus, $vettedUser, $waterfallStatus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiObservationsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $end = 2013-10-20T19:20:30+01:00; # Date | 
my $groundStation = 56; # Integer | 
my $id = 56; # Integer | 
my $page = 56; # Integer | A page number within the paginated result set.
my $satelliteNoradCatId = 56; # Integer | 
my $start = 2013-10-20T19:20:30+01:00; # Date | 
my $status = status_example; # String | 
my $transmitterMode = transmitterMode_example; # String | 
my $transmitterType = transmitterType_example; # String | 
my $transmitterUuid = transmitterUuid_example; # String | 
my $vettedStatus = vettedStatus_example; # String | Vetted status (deprecated: please use Status)
my $vettedUser = 56; # Integer | Vetted user (deprecated: will be removed in next version)
my $waterfallStatus = true; # Boolean | 

eval { 
    my $result = $api_instance->apiObservationsList(end => $end, groundStation => $groundStation, id => $id, page => $page, satelliteNoradCatId => $satelliteNoradCatId, start => $start, status => $status, transmitterMode => $transmitterMode, transmitterType => $transmitterType, transmitterUuid => $transmitterUuid, vettedStatus => $vettedStatus, vettedUser => $vettedUser, waterfallStatus => $waterfallStatus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiObservationsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
end = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
groundStation = 56 # Integer |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
page = 56 # Integer | A page number within the paginated result set. (optional) (default to null)
satelliteNoradCatId = 56 # Integer |  (optional) (default to null)
start = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
status = status_example # String |  (optional) (default to null)
transmitterMode = transmitterMode_example # String |  (optional) (default to null)
transmitterType = transmitterType_example # String |  (optional) (default to null)
transmitterUuid = transmitterUuid_example # String |  (optional) (default to null)
vettedStatus = vettedStatus_example # String | Vetted status (deprecated: please use Status) (optional) (default to null)
vettedUser = 56 # Integer | Vetted user (deprecated: will be removed in next version) (optional) (default to null)
waterfallStatus = true # Boolean |  (optional) (default to null)

try: 
    api_response = api_instance.api_observations_list(end=end, groundStation=groundStation, id=id, page=page, satelliteNoradCatId=satelliteNoradCatId, start=start, status=status, transmitterMode=transmitterMode, transmitterType=transmitterType, transmitterUuid=transmitterUuid, vettedStatus=vettedStatus, vettedUser=vettedUser, waterfallStatus=waterfallStatus)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiObservationsList: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let end = 2013-10-20T19:20:30+01:00; // Date
    let groundStation = 56; // Integer
    let id = 56; // Integer
    let page = 56; // Integer
    let satelliteNoradCatId = 56; // Integer
    let start = 2013-10-20T19:20:30+01:00; // Date
    let status = status_example; // String
    let transmitterMode = transmitterMode_example; // String
    let transmitterType = transmitterType_example; // String
    let transmitterUuid = transmitterUuid_example; // String
    let vettedStatus = vettedStatus_example; // String
    let vettedUser = 56; // Integer
    let waterfallStatus = true; // Boolean

    let mut context = ApiApi::Context::default();
    let result = client.apiObservationsList(end, groundStation, id, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
end
Date (date-time)
ground_station
Integer
id
Integer
page
Integer
A page number within the paginated result set.
satellite__norad_cat_id
Integer
start
Date (date-time)
status
String
transmitter_mode
String
transmitter_type
String
transmitter_uuid
String
vetted_status
String
Vetted status (deprecated: please use Status)
vetted_user
Integer
Vetted user (deprecated: will be removed in next version)
waterfall_status
Boolean

Responses


apiObservationsPartialUpdate

SatNOGS Network Observation API view class


/api/observations/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
 "http://localhost/api/observations/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        PatchedObservation patchedObservation = ; // PatchedObservation | 
        
        try {
            Observation result = apiInstance.apiObservationsPartialUpdate(id, patchedObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsPartialUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        PatchedObservation patchedObservation = ; // PatchedObservation | 
        
        try {
            Observation result = apiInstance.apiObservationsPartialUpdate(id, patchedObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsPartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)
PatchedObservation *patchedObservation = ; //  (optional)

[apiInstance apiObservationsPartialUpdateWith:id
    patchedObservation:patchedObservation
              completionHandler: ^(Observation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var id = 56; // {Integer} A unique integer value identifying this observation.
var opts = {
  'patchedObservation':  // {PatchedObservation} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiObservationsPartialUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiObservationsPartialUpdateExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)
            var patchedObservation = new PatchedObservation(); // PatchedObservation |  (optional) 

            try {
                Observation result = apiInstance.apiObservationsPartialUpdate(id, patchedObservation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiObservationsPartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$id = 56; // Integer | A unique integer value identifying this observation.
$patchedObservation = ; // PatchedObservation | 

try {
    $result = $api_instance->apiObservationsPartialUpdate($id, $patchedObservation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiObservationsPartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.
my $patchedObservation = WWW::OPenAPIClient::Object::PatchedObservation->new(); # PatchedObservation | 

eval { 
    my $result = $api_instance->apiObservationsPartialUpdate(id => $id, patchedObservation => $patchedObservation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiObservationsPartialUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)
patchedObservation =  # PatchedObservation |  (optional)

try: 
    api_response = api_instance.api_observations_partial_update(id, patchedObservation=patchedObservation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiObservationsPartialUpdate: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let id = 56; // Integer
    let patchedObservation = ; // PatchedObservation

    let mut context = ApiApi::Context::default();
    let result = client.apiObservationsPartialUpdate(id, patchedObservation, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this observation.
Required
Body parameters
Name Description
patchedObservation

Responses


apiObservationsRetrieve

SatNOGS Network Observation API view class


/api/observations/{id}/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/observations/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        
        try {
            Observation result = apiInstance.apiObservationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsRetrieve");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        
        try {
            Observation result = apiInstance.apiObservationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)

[apiInstance apiObservationsRetrieveWith:id
              completionHandler: ^(Observation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var id = 56; // {Integer} A unique integer value identifying this observation.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiObservationsRetrieve(id, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiObservationsRetrieveExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)

            try {
                Observation result = apiInstance.apiObservationsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiObservationsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$id = 56; // Integer | A unique integer value identifying this observation.

try {
    $result = $api_instance->apiObservationsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiObservationsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.

eval { 
    my $result = $api_instance->apiObservationsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiObservationsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)

try: 
    api_response = api_instance.api_observations_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiObservationsRetrieve: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = ApiApi::Context::default();
    let result = client.apiObservationsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this observation.
Required

Responses


apiObservationsUpdate

Updates observation with audio, waterfall or demoded data


/api/observations/{id}/

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
 "http://localhost/api/observations/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        Observation observation = ; // Observation | 
        
        try {
            Observation result = apiInstance.apiObservationsUpdate(id, observation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        Observation observation = ; // Observation | 
        
        try {
            Observation result = apiInstance.apiObservationsUpdate(id, observation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiObservationsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)
Observation *observation = ; //  (optional)

[apiInstance apiObservationsUpdateWith:id
    observation:observation
              completionHandler: ^(Observation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var id = 56; // {Integer} A unique integer value identifying this observation.
var opts = {
  'observation':  // {Observation} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiObservationsUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiObservationsUpdateExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)
            var observation = new Observation(); // Observation |  (optional) 

            try {
                Observation result = apiInstance.apiObservationsUpdate(id, observation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiObservationsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$id = 56; // Integer | A unique integer value identifying this observation.
$observation = ; // Observation | 

try {
    $result = $api_instance->apiObservationsUpdate($id, $observation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiObservationsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.
my $observation = WWW::OPenAPIClient::Object::Observation->new(); # Observation | 

eval { 
    my $result = $api_instance->apiObservationsUpdate(id => $id, observation => $observation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiObservationsUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)
observation =  # Observation |  (optional)

try: 
    api_response = api_instance.api_observations_update(id, observation=observation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiObservationsUpdate: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let id = 56; // Integer
    let observation = ; // Observation

    let mut context = ApiApi::Context::default();
    let result = client.apiObservationsUpdate(id, observation, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this observation.
Required
Body parameters
Name Description
observation

Responses


apiStationsList

SatNOGS Network Station API view class


/api/stations/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/stations/?client_version=&id=&name=&page=&status="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        String clientVersion = clientVersion_example; // String | 
        Integer id = 56; // Integer | 
        String name = name_example; // String | 
        Integer page = 56; // Integer | A page number within the paginated result set.
        Integer status = 56; // Integer | 
        
        try {
            PaginatedStationList result = apiInstance.apiStationsList(clientVersion, id, name, page, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiStationsList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String clientVersion = clientVersion_example; // String | 
        Integer id = 56; // Integer | 
        String name = name_example; // String | 
        Integer page = 56; // Integer | A page number within the paginated result set.
        Integer status = 56; // Integer | 
        
        try {
            PaginatedStationList result = apiInstance.apiStationsList(clientVersion, id, name, page, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiStationsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
String *clientVersion = clientVersion_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
Integer *page = 56; // A page number within the paginated result set. (optional) (default to null)
Integer *status = 56; //  (optional) (default to null)

[apiInstance apiStationsListWith:clientVersion
    id:id
    name:name
    page:page
    status:status
              completionHandler: ^(PaginatedStationList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var opts = {
  'clientVersion': clientVersion_example, // {String} 
  'id': 56, // {Integer} 
  'name': name_example, // {String} 
  'page': 56, // {Integer} A page number within the paginated result set.
  'status': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiStationsList(opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiStationsListExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var clientVersion = clientVersion_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var page = 56;  // Integer | A page number within the paginated result set. (optional)  (default to null)
            var status = 56;  // Integer |  (optional)  (default to null)

            try {
                PaginatedStationList result = apiInstance.apiStationsList(clientVersion, id, name, page, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiStationsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$clientVersion = clientVersion_example; // String | 
$id = 56; // Integer | 
$name = name_example; // String | 
$page = 56; // Integer | A page number within the paginated result set.
$status = 56; // Integer | 

try {
    $result = $api_instance->apiStationsList($clientVersion, $id, $name, $page, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiStationsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $clientVersion = clientVersion_example; # String | 
my $id = 56; # Integer | 
my $name = name_example; # String | 
my $page = 56; # Integer | A page number within the paginated result set.
my $status = 56; # Integer | 

eval { 
    my $result = $api_instance->apiStationsList(clientVersion => $clientVersion, id => $id, name => $name, page => $page, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiStationsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
clientVersion = clientVersion_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
name = name_example # String |  (optional) (default to null)
page = 56 # Integer | A page number within the paginated result set. (optional) (default to null)
status = 56 # Integer |  (optional) (default to null)

try: 
    api_response = api_instance.api_stations_list(clientVersion=clientVersion, id=id, name=name, page=page, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiStationsList: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let clientVersion = clientVersion_example; // String
    let id = 56; // Integer
    let name = name_example; // String
    let page = 56; // Integer
    let status = 56; // Integer

    let mut context = ApiApi::Context::default();
    let result = client.apiStationsList(clientVersion, id, name, page, status, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
client_version
String
id
Integer
name
String
page
Integer
A page number within the paginated result set.
status
Integer

Responses


apiStationsRetrieve

SatNOGS Network Station API view class


/api/stations/{id}/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/stations/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this station.
        
        try {
            Station result = apiInstance.apiStationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiStationsRetrieve");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer id = 56; // Integer | A unique integer value identifying this station.
        
        try {
            Station result = apiInstance.apiStationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiStationsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Integer *id = 56; // A unique integer value identifying this station. (default to null)

[apiInstance apiStationsRetrieveWith:id
              completionHandler: ^(Station output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var id = 56; // {Integer} A unique integer value identifying this station.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiStationsRetrieve(id, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiStationsRetrieveExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var id = 56;  // Integer | A unique integer value identifying this station. (default to null)

            try {
                Station result = apiInstance.apiStationsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiStationsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$id = 56; // Integer | A unique integer value identifying this station.

try {
    $result = $api_instance->apiStationsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiStationsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $id = 56; # Integer | A unique integer value identifying this station.

eval { 
    my $result = $api_instance->apiStationsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiStationsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
id = 56 # Integer | A unique integer value identifying this station. (default to null)

try: 
    api_response = api_instance.api_stations_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiStationsRetrieve: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = ApiApi::Context::default();
    let result = client.apiStationsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
A unique integer value identifying this station.
Required

Responses


apiTransmittersList

SatNOGS Network Transmitter API view class


/api/transmitters/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/transmitters/?page=&uuid="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        String uuid = uuid_example; // String | 
        
        try {
            PaginatedTransmitterList result = apiInstance.apiTransmittersList(page, uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransmittersList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        String uuid = uuid_example; // String | 
        
        try {
            PaginatedTransmitterList result = apiInstance.apiTransmittersList(page, uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransmittersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
Integer *page = 56; // A page number within the paginated result set. (optional) (default to null)
String *uuid = uuid_example; //  (optional) (default to null)

[apiInstance apiTransmittersListWith:page
    uuid:uuid
              completionHandler: ^(PaginatedTransmitterList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var opts = {
  'page': 56, // {Integer} A page number within the paginated result set.
  'uuid': uuid_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiTransmittersList(opts, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiTransmittersListExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional)  (default to null)
            var uuid = uuid_example;  // String |  (optional)  (default to null)

            try {
                PaginatedTransmitterList result = apiInstance.apiTransmittersList(page, uuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiTransmittersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$page = 56; // Integer | A page number within the paginated result set.
$uuid = uuid_example; // String | 

try {
    $result = $api_instance->apiTransmittersList($page, $uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiTransmittersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.
my $uuid = uuid_example; # String | 

eval { 
    my $result = $api_instance->apiTransmittersList(page => $page, uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransmittersList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional) (default to null)
uuid = uuid_example # String |  (optional) (default to null)

try: 
    api_response = api_instance.api_transmitters_list(page=page, uuid=uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransmittersList: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let page = 56; // Integer
    let uuid = uuid_example; // String

    let mut context = ApiApi::Context::default();
    let result = client.apiTransmittersList(page, uuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.
uuid
String

Responses


apiTransmittersRetrieve

SatNOGS Network Transmitter API view class


/api/transmitters/{transmitter_uuid}/

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
 -H "Accept: application/json"\
 "http://localhost/api/transmitters/{transmitter_uuid}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ApiApi apiInstance = new ApiApi();
        String transmitterUuid = transmitterUuid_example; // String | 
        
        try {
            Transmitter result = apiInstance.apiTransmittersRetrieve(transmitterUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransmittersRetrieve");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiApi;

public class ApiApiExample {
    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String transmitterUuid = transmitterUuid_example; // String | 
        
        try {
            Transmitter result = apiInstance.apiTransmittersRetrieve(transmitterUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#apiTransmittersRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
ApiApi *apiInstance = [[ApiApi alloc] init];
String *transmitterUuid = transmitterUuid_example; //  (default to null)

[apiInstance apiTransmittersRetrieveWith:transmitterUuid
              completionHandler: ^(Transmitter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenapiJsClient = require('openapi-js-client');
var defaultClient = OpenapiJsClient.ApiClient.instance;

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new OpenapiJsClient.ApiApi()
var transmitterUuid = transmitterUuid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiTransmittersRetrieve(transmitterUuid, callback);
using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class apiTransmittersRetrieveExample
    {
        public void main()
        {
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ApiApi();
            var transmitterUuid = transmitterUuid_example;  // String |  (default to null)

            try {
                Transmitter result = apiInstance.apiTransmittersRetrieve(transmitterUuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiApi.apiTransmittersRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiApi();
$transmitterUuid = transmitterUuid_example; // String | 

try {
    $result = $api_instance->apiTransmittersRetrieve($transmitterUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiApi->apiTransmittersRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiApi;

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiApi->new();
my $transmitterUuid = transmitterUuid_example; # String | 

eval { 
    my $result = $api_instance->apiTransmittersRetrieve(transmitterUuid => $transmitterUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiApi->apiTransmittersRetrieve: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: tokenAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ApiApi()
transmitterUuid = transmitterUuid_example # String |  (default to null)

try: 
    api_response = api_instance.api_transmitters_retrieve(transmitterUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->apiTransmittersRetrieve: %s\n" % e)
extern crate ApiApi;

pub fn main() {
    let transmitterUuid = transmitterUuid_example; // String

    let mut context = ApiApi::Context::default();
    let result = client.apiTransmittersRetrieve(transmitterUuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
transmitter_uuid*
String
Required

Responses