OpenAPI Sample

Configuration

configurationList

SatNOGS Network Station Configuration API view class

/api/configuration/

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/configuration/"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

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

public class ConfigurationApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            array[StationConfiguration] result = apiInstance.configurationList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#configurationList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            array[StationConfiguration] result = apiInstance.configurationList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#configurationList");
            e.printStackTrace();
        }
    }
}



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

[apiInstance configurationListWithCompletionHandler: 
              ^(array[StationConfiguration] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var OpenapiJsClient = require('openapi-js-client');

// Create an instance of the API class
var api = new OpenapiJsClient.ConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.configurationList(callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class configurationListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();

            try {
                array[StationConfiguration] result = apiInstance.configurationList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.configurationList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();

try {
    $result = $api_instance->configurationList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->configurationList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();

eval {
    my $result = $api_instance->configurationList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->configurationList: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()

try:
    api_response = api_instance.configuration_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->configurationList: %s\n" % e)

extern crate ConfigurationApi;

pub fn main() {

    let mut context = ConfigurationApi::Context::default();
    let result = client.configurationList(&context).wait();

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

Scopes

Parameters

Responses

Schema

configurationRetrieve

SatNOGS Network Station Configuration API view class

/api/configuration/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/configuration/{id}/"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

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

public class ConfigurationApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        Integer id = 56; // Integer | A unique integer value identifying this station.

        try {
            StationConfiguration result = apiInstance.configurationRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#configurationRetrieve");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        Integer id = 56; // Integer | A unique integer value identifying this station.

        try {
            StationConfiguration result = apiInstance.configurationRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#configurationRetrieve");
            e.printStackTrace();
        }
    }
}



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

[apiInstance configurationRetrieveWith:id
              completionHandler: ^(StationConfiguration output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var OpenapiJsClient = require('openapi-js-client');

// Create an instance of the API class
var api = new OpenapiJsClient.ConfigurationApi()
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.configurationRetrieve(id, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class configurationRetrieveExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var id = 56;  // Integer | A unique integer value identifying this station. (default to null)

            try {
                StationConfiguration result = apiInstance.configurationRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.configurationRetrieve: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->configurationRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->configurationRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

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

eval {
    my $result = $api_instance->configurationRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->configurationRetrieve: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

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

try:
    api_response = api_instance.configuration_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->configurationRetrieve: %s\n" % e)

extern crate ConfigurationApi;

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

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

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

Scopes

Parameters

Path parameters

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

Responses

Schema

Jobs

jobsList

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=2013-10-20T19:20:30+01:00&ground_station=56&id=56&observer=56&satellite__norad_cat_id=56&start=2013-10-20T19:20:30+01:00&status=56&transmitter_mode=transmitterMode_example&transmitter_type=transmitterType_example&transmitter_uuid=transmitterUuid_example&vetted_status=56&vetted_user=56&waterfall_status=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

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

public class JobsApiExample {
    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
        JobsApi apiInstance = new JobsApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer observer = 56; // Integer | observer
        Integer satelliteNoradCatId = 56; // Integer | 
        Date start = 2013-10-20T19:20:30+01:00; // Date | 
        Integer status = 56; // Integer | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        Integer vettedStatus = 56; // Integer | 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.jobsList(end, groundStation, id, observer, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer observer = 56; // Integer | observer
        Integer satelliteNoradCatId = 56; // Integer | 
        Date start = 2013-10-20T19:20:30+01:00; // Date | 
        Integer status = 56; // Integer | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        Integer vettedStatus = 56; // Integer | 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.jobsList(end, groundStation, id, observer, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsList");
            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
JobsApi *apiInstance = [[JobsApi 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 *observer = 56; // observer (optional) (default to null)
Integer *satelliteNoradCatId = 56; //  (optional) (default to null)
Date *start = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *status = 56; //  (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)
Integer *vettedStatus = 56; // 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 jobsListWith:end
    groundStation:groundStation
    id:id
    observer:observer
    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.JobsApi()
var opts = {
  'end': 2013-10-20T19:20:30+01:00, // {Date} 
  'groundStation': 56, // {Integer} 
  'id': 56, // {Integer} 
  'observer': 56, // {Integer} observer
  'satelliteNoradCatId': 56, // {Integer} 
  'start': 2013-10-20T19:20:30+01:00, // {Date} 
  'status': 56, // {Integer} 
  'transmitterMode': transmitterMode_example, // {String} 
  'transmitterType': transmitterType_example, // {String} 
  'transmitterUuid': transmitterUuid_example, // {String} 
  'vettedStatus': 56, // {Integer} 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.jobsList(opts, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class jobsListExample
    {
        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 JobsApi();
            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 observer = 56;  // Integer | observer (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 = 56;  // Integer |  (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 = 56;  // Integer | 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.jobsList(end, groundStation, id, observer, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.jobsList: " + 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\JobsApi();
$end = 2013-10-20T19:20:30+01:00; // Date | 
$groundStation = 56; // Integer | 
$id = 56; // Integer | 
$observer = 56; // Integer | observer
$satelliteNoradCatId = 56; // Integer | 
$start = 2013-10-20T19:20:30+01:00; // Date | 
$status = 56; // Integer | 
$transmitterMode = transmitterMode_example; // String | 
$transmitterType = transmitterType_example; // String | 
$transmitterUuid = transmitterUuid_example; // String | 
$vettedStatus = 56; // Integer | 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->jobsList($end, $groundStation, $id, $observer, $satelliteNoradCatId, $start, $status, $transmitterMode, $transmitterType, $transmitterUuid, $vettedStatus, $vettedUser, $waterfallStatus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobsList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# 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::JobsApi->new();
my $end = 2013-10-20T19:20:30+01:00; # Date | 
my $groundStation = 56; # Integer | 
my $id = 56; # Integer | 
my $observer = 56; # Integer | observer
my $satelliteNoradCatId = 56; # Integer | 
my $start = 2013-10-20T19:20:30+01:00; # Date | 
my $status = 56; # Integer | 
my $transmitterMode = transmitterMode_example; # String | 
my $transmitterType = transmitterType_example; # String | 
my $transmitterUuid = transmitterUuid_example; # String | 
my $vettedStatus = 56; # Integer | 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->jobsList(end => $end, groundStation => $groundStation, id => $id, observer => $observer, 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 JobsApi->jobsList: $@\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.JobsApi()
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)
observer = 56 # Integer | observer (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 = 56 # Integer |  (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 = 56 # Integer | 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.jobs_list(end=end, groundStation=groundStation, id=id, observer=observer, 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 JobsApi->jobsList: %s\n" % e)

extern crate JobsApi;

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

    let mut context = JobsApi::Context::default();
    let result = client.jobsList(end, groundStation, id, observer, 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
observer	Integer observer
satellite__norad_cat_id	Integer
start	Date (date-time)
status	Integer
transmitter_mode	String
transmitter_type	String
transmitter_uuid	String
vetted_status	Integer Vetted status (deprecated: please use Status)
vetted_user	Integer Vetted user (deprecated: will be removed in next version)
waterfall_status	Boolean

Responses

Schema

jobsRetrieve

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.JobsApi;

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

public class JobsApiExample {
    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
        JobsApi apiInstance = new JobsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.

        try {
            Job result = apiInstance.jobsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsRetrieve");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.JobsApi;

public class JobsApiExample {
    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.

        try {
            Job result = apiInstance.jobsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsRetrieve");
            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
JobsApi *apiInstance = [[JobsApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)

[apiInstance jobsRetrieveWith: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.JobsApi()
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.jobsRetrieve(id, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class jobsRetrieveExample
    {
        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 JobsApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)

            try {
                Job result = apiInstance.jobsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobsApi.jobsRetrieve: " + 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\JobsApi();
$id = 56; // Integer | A unique integer value identifying this observation.

try {
    $result = $api_instance->jobsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

# 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::JobsApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.

eval {
    my $result = $api_instance->jobsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobsRetrieve: $@\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.JobsApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)

try:
    api_response = api_instance.jobs_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobsRetrieve: %s\n" % e)

extern crate JobsApi;

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

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

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

Scopes

Parameters

Path parameters

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

Responses

Schema

Observations

observationsCreate

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/" \
 -d '{
  "transmitter_uuid" : "transmitter_uuid",
  "start" : "2000-01-23T04:56:07.000+00:00",
  "end" : "2000-01-23T04:56:07.000+00:00",
  "ground_station" : 0
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ObservationsApi;

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

public class ObservationsApiExample {
    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
        ObservationsApi apiInstance = new ObservationsApi();
        NewObservation newObservation = ; // NewObservation | 

        try {
            NewObservation result = apiInstance.observationsCreate(newObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsCreate");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ObservationsApi;

public class ObservationsApiExample {
    public static void main(String[] args) {
        ObservationsApi apiInstance = new ObservationsApi();
        NewObservation newObservation = ; // NewObservation | 

        try {
            NewObservation result = apiInstance.observationsCreate(newObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsCreate");
            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
ObservationsApi *apiInstance = [[ObservationsApi alloc] init];
NewObservation *newObservation = ; // 

[apiInstance observationsCreateWith: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.ObservationsApi()
var newObservation = ; // {NewObservation} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationsCreate(newObservation, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class observationsCreateExample
    {
        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 ObservationsApi();
            var newObservation = new NewObservation(); // NewObservation | 

            try {
                NewObservation result = apiInstance.observationsCreate(newObservation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ObservationsApi.observationsCreate: " + 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\ObservationsApi();
$newObservation = ; // NewObservation | 

try {
    $result = $api_instance->observationsCreate($newObservation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObservationsApi->observationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ObservationsApi;

# 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::ObservationsApi->new();
my $newObservation = WWW::OPenAPIClient::Object::NewObservation->new(); # NewObservation | 

eval {
    my $result = $api_instance->observationsCreate(newObservation => $newObservation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationsApi->observationsCreate: $@\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.ObservationsApi()
newObservation =  # NewObservation | 

try:
    api_response = api_instance.observations_create(newObservation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationsApi->observationsCreate: %s\n" % e)

extern crate ObservationsApi;

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

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

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

Scopes

Parameters

Body parameters

Name	Description
newObservation *

Responses

Schema

observationsList

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=2013-10-20T19:20:30+01:00&ground_station=56&id=56&observer=56&page=56&satellite__norad_cat_id=56&start=2013-10-20T19:20:30+01:00&status=56&transmitter_mode=transmitterMode_example&transmitter_type=transmitterType_example&transmitter_uuid=transmitterUuid_example&vetted_status=56&vetted_user=56&waterfall_status=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ObservationsApi;

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

public class ObservationsApiExample {
    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
        ObservationsApi apiInstance = new ObservationsApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer observer = 56; // Integer | observer
        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 | 
        Integer status = 56; // Integer | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        Integer vettedStatus = 56; // Integer | 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.observationsList(end, groundStation, id, observer, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ObservationsApi;

public class ObservationsApiExample {
    public static void main(String[] args) {
        ObservationsApi apiInstance = new ObservationsApi();
        Date end = 2013-10-20T19:20:30+01:00; // Date | 
        Integer groundStation = 56; // Integer | 
        Integer id = 56; // Integer | 
        Integer observer = 56; // Integer | observer
        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 | 
        Integer status = 56; // Integer | 
        String transmitterMode = transmitterMode_example; // String | 
        String transmitterType = transmitterType_example; // String | 
        String transmitterUuid = transmitterUuid_example; // String | 
        Integer vettedStatus = 56; // Integer | 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.observationsList(end, groundStation, id, observer, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsList");
            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
ObservationsApi *apiInstance = [[ObservationsApi 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 *observer = 56; // observer (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)
Integer *status = 56; //  (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)
Integer *vettedStatus = 56; // 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 observationsListWith:end
    groundStation:groundStation
    id:id
    observer:observer
    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.ObservationsApi()
var opts = {
  'end': 2013-10-20T19:20:30+01:00, // {Date} 
  'groundStation': 56, // {Integer} 
  'id': 56, // {Integer} 
  'observer': 56, // {Integer} observer
  'page': 56, // {Integer} A page number within the paginated result set.
  'satelliteNoradCatId': 56, // {Integer} 
  'start': 2013-10-20T19:20:30+01:00, // {Date} 
  'status': 56, // {Integer} 
  'transmitterMode': transmitterMode_example, // {String} 
  'transmitterType': transmitterType_example, // {String} 
  'transmitterUuid': transmitterUuid_example, // {String} 
  'vettedStatus': 56, // {Integer} 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.observationsList(opts, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class observationsListExample
    {
        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 ObservationsApi();
            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 observer = 56;  // Integer | observer (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 = 56;  // Integer |  (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 = 56;  // Integer | 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.observationsList(end, groundStation, id, observer, page, satelliteNoradCatId, start, status, transmitterMode, transmitterType, transmitterUuid, vettedStatus, vettedUser, waterfallStatus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ObservationsApi.observationsList: " + 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\ObservationsApi();
$end = 2013-10-20T19:20:30+01:00; // Date | 
$groundStation = 56; // Integer | 
$id = 56; // Integer | 
$observer = 56; // Integer | observer
$page = 56; // Integer | A page number within the paginated result set.
$satelliteNoradCatId = 56; // Integer | 
$start = 2013-10-20T19:20:30+01:00; // Date | 
$status = 56; // Integer | 
$transmitterMode = transmitterMode_example; // String | 
$transmitterType = transmitterType_example; // String | 
$transmitterUuid = transmitterUuid_example; // String | 
$vettedStatus = 56; // Integer | 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->observationsList($end, $groundStation, $id, $observer, $page, $satelliteNoradCatId, $start, $status, $transmitterMode, $transmitterType, $transmitterUuid, $vettedStatus, $vettedUser, $waterfallStatus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObservationsApi->observationsList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ObservationsApi;

# 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::ObservationsApi->new();
my $end = 2013-10-20T19:20:30+01:00; # Date | 
my $groundStation = 56; # Integer | 
my $id = 56; # Integer | 
my $observer = 56; # Integer | observer
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 = 56; # Integer | 
my $transmitterMode = transmitterMode_example; # String | 
my $transmitterType = transmitterType_example; # String | 
my $transmitterUuid = transmitterUuid_example; # String | 
my $vettedStatus = 56; # Integer | 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->observationsList(end => $end, groundStation => $groundStation, id => $id, observer => $observer, 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 ObservationsApi->observationsList: $@\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.ObservationsApi()
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)
observer = 56 # Integer | observer (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 = 56 # Integer |  (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 = 56 # Integer | 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.observations_list(end=end, groundStation=groundStation, id=id, observer=observer, 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 ObservationsApi->observationsList: %s\n" % e)

extern crate ObservationsApi;

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

    let mut context = ObservationsApi::Context::default();
    let result = client.observationsList(end, groundStation, id, observer, 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
observer	Integer observer
page	Integer A page number within the paginated result set.
satellite__norad_cat_id	Integer
start	Date (date-time)
status	Integer
transmitter_mode	String
transmitter_type	String
transmitter_uuid	String
vetted_status	Integer Vetted status (deprecated: please use Status)
vetted_user	Integer Vetted user (deprecated: will be removed in next version)
waterfall_status	Boolean

Responses

Schema

observationsPartialUpdate

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}/" \
 -d '{
  "transmitter_invert" : true,
  "transmitter_uplink_low" : 7,
  "transmitter_type" : "",
  "transmitter_uuid" : "transmitter_uuid",
  "vetted_user" : "vetted_user",
  "transmitter_downlink_drift" : 7,
  "transmitter_uplink_high" : 9,
  "norad_cat_id" : "norad_cat_id",
  "archived" : true,
  "station_alt" : "station_alt",
  "tle1" : "tle1",
  "tle2" : "tle2",
  "payload" : "payload",
  "vetted_status" : "vetted_status",
  "tle0" : "tle0",
  "waterfall" : "waterfall",
  "station_lng" : "station_lng",
  "station_lat" : "station_lat",
  "end" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "ground_station" : 6,
  "client_version" : "client_version",
  "max_altitude" : 2.3021358869347655,
  "transmitter" : "transmitter",
  "transmitter_baud" : 1.2315135367772556,
  "station_name" : "station_name",
  "archive_url" : "https://openapi-generator.tech",
  "set_azimuth" : 5.637376656633329,
  "transmitter_downlink_high" : 4,
  "start" : "2000-01-23T04:56:07.000+00:00",
  "transmitter_uplink_drift" : 3,
  "transmitter_downlink_low" : 2,
  "rise_azimuth" : 5.962133916683182,
  "waterfall_status_user" : 1,
  "transmitter_updated" : "transmitter_updated",
  "waterfall_status" : "waterfall_status",
  "transmitter_description" : "transmitter_description",
  "transmitter_mode" : "transmitter_mode",
  "vetted_datetime" : "vetted_datetime",
  "waterfall_status_datetime" : "2000-01-23T04:56:07.000+00:00",
  "demoddata" : [ {
    "payload_demod" : "payload_demod"
  }, {
    "payload_demod" : "payload_demod"
  } ],
  "client_metadata" : "client_metadata",
  "status" : "status"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ObservationsApi;

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

public class ObservationsApiExample {
    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
        ObservationsApi apiInstance = new ObservationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        PatchedObservation patchedObservation = ; // PatchedObservation | 

        try {
            Observation result = apiInstance.observationsPartialUpdate(id, patchedObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsPartialUpdate");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ObservationsApi;

public class ObservationsApiExample {
    public static void main(String[] args) {
        ObservationsApi apiInstance = new ObservationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        PatchedObservation patchedObservation = ; // PatchedObservation | 

        try {
            Observation result = apiInstance.observationsPartialUpdate(id, patchedObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsPartialUpdate");
            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
ObservationsApi *apiInstance = [[ObservationsApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)
PatchedObservation *patchedObservation = ; //  (optional)

[apiInstance observationsPartialUpdateWith: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.ObservationsApi()
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.observationsPartialUpdate(id, opts, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class observationsPartialUpdateExample
    {
        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 ObservationsApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)
            var patchedObservation = new PatchedObservation(); // PatchedObservation |  (optional) 

            try {
                Observation result = apiInstance.observationsPartialUpdate(id, patchedObservation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ObservationsApi.observationsPartialUpdate: " + 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\ObservationsApi();
$id = 56; // Integer | A unique integer value identifying this observation.
$patchedObservation = ; // PatchedObservation | 

try {
    $result = $api_instance->observationsPartialUpdate($id, $patchedObservation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObservationsApi->observationsPartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ObservationsApi;

# 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::ObservationsApi->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->observationsPartialUpdate(id => $id, patchedObservation => $patchedObservation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationsApi->observationsPartialUpdate: $@\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.ObservationsApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)
patchedObservation =  # PatchedObservation |  (optional)

try:
    api_response = api_instance.observations_partial_update(id, patchedObservation=patchedObservation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationsApi->observationsPartialUpdate: %s\n" % e)

extern crate ObservationsApi;

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

    let mut context = ObservationsApi::Context::default();
    let result = client.observationsPartialUpdate(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

Schema

observationsRetrieve

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.ObservationsApi;

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

public class ObservationsApiExample {
    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
        ObservationsApi apiInstance = new ObservationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.

        try {
            Observation result = apiInstance.observationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsRetrieve");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ObservationsApi;

public class ObservationsApiExample {
    public static void main(String[] args) {
        ObservationsApi apiInstance = new ObservationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.

        try {
            Observation result = apiInstance.observationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsRetrieve");
            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
ObservationsApi *apiInstance = [[ObservationsApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)

[apiInstance observationsRetrieveWith: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.ObservationsApi()
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.observationsRetrieve(id, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class observationsRetrieveExample
    {
        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 ObservationsApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)

            try {
                Observation result = apiInstance.observationsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ObservationsApi.observationsRetrieve: " + 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\ObservationsApi();
$id = 56; // Integer | A unique integer value identifying this observation.

try {
    $result = $api_instance->observationsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObservationsApi->observationsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ObservationsApi;

# 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::ObservationsApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.

eval {
    my $result = $api_instance->observationsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationsApi->observationsRetrieve: $@\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.ObservationsApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)

try:
    api_response = api_instance.observations_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationsApi->observationsRetrieve: %s\n" % e)

extern crate ObservationsApi;

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

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

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

Scopes

Parameters

Path parameters

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

Responses

Schema

observationsUpdate

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}/" \
 -d '{
  "payload" : "https://openapi-generator.tech",
  "waterfall" : "https://openapi-generator.tech",
  "id" : 0,
  "client_version" : "client_version",
  "client_metadata" : "client_metadata"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ObservationsApi;

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

public class ObservationsApiExample {
    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
        ObservationsApi apiInstance = new ObservationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        UpdateObservation updateObservation = ; // UpdateObservation | 

        try {
            UpdateObservation result = apiInstance.observationsUpdate(id, updateObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsUpdate");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ObservationsApi;

public class ObservationsApiExample {
    public static void main(String[] args) {
        ObservationsApi apiInstance = new ObservationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this observation.
        UpdateObservation updateObservation = ; // UpdateObservation | 

        try {
            UpdateObservation result = apiInstance.observationsUpdate(id, updateObservation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationsApi#observationsUpdate");
            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
ObservationsApi *apiInstance = [[ObservationsApi alloc] init];
Integer *id = 56; // A unique integer value identifying this observation. (default to null)
UpdateObservation *updateObservation = ; //  (optional)

[apiInstance observationsUpdateWith:id
    updateObservation:updateObservation
              completionHandler: ^(UpdateObservation 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.ObservationsApi()
var id = 56; // {Integer} A unique integer value identifying this observation.
var opts = {
  'updateObservation':  // {UpdateObservation} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationsUpdate(id, opts, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class observationsUpdateExample
    {
        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 ObservationsApi();
            var id = 56;  // Integer | A unique integer value identifying this observation. (default to null)
            var updateObservation = new UpdateObservation(); // UpdateObservation |  (optional) 

            try {
                UpdateObservation result = apiInstance.observationsUpdate(id, updateObservation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ObservationsApi.observationsUpdate: " + 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\ObservationsApi();
$id = 56; // Integer | A unique integer value identifying this observation.
$updateObservation = ; // UpdateObservation | 

try {
    $result = $api_instance->observationsUpdate($id, $updateObservation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObservationsApi->observationsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ObservationsApi;

# 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::ObservationsApi->new();
my $id = 56; # Integer | A unique integer value identifying this observation.
my $updateObservation = WWW::OPenAPIClient::Object::UpdateObservation->new(); # UpdateObservation | 

eval {
    my $result = $api_instance->observationsUpdate(id => $id, updateObservation => $updateObservation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationsApi->observationsUpdate: $@\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.ObservationsApi()
id = 56 # Integer | A unique integer value identifying this observation. (default to null)
updateObservation =  # UpdateObservation |  (optional)

try:
    api_response = api_instance.observations_update(id, updateObservation=updateObservation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationsApi->observationsUpdate: %s\n" % e)

extern crate ObservationsApi;

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

    let mut context = ObservationsApi::Context::default();
    let result = client.observationsUpdate(id, updateObservation, &context).wait();

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

Scopes

Parameters

Path parameters

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

Body parameters

Name	Description
updateObservation

Responses

Schema

Station

stationRegisterCreate

API endpoint for receiving client_id and return url for registering new station or connect client_id to existing one

/api/station/register

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 "http://localhost/api/station/register"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StationApi;

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

public class StationApiExample {
    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
        StationApi apiInstance = new StationApi();

        try {
            apiInstance.stationRegisterCreate();
        } catch (ApiException e) {
            System.err.println("Exception when calling StationApi#stationRegisterCreate");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.StationApi;

public class StationApiExample {
    public static void main(String[] args) {
        StationApi apiInstance = new StationApi();

        try {
            apiInstance.stationRegisterCreate();
        } catch (ApiException e) {
            System.err.println("Exception when calling StationApi#stationRegisterCreate");
            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
StationApi *apiInstance = [[StationApi alloc] init];

[apiInstance stationRegisterCreateWithCompletionHandler: 
              ^(NSError* error) {
    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.StationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stationRegisterCreate(callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class stationRegisterCreateExample
    {
        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 StationApi();

            try {
                apiInstance.stationRegisterCreate();
            } catch (Exception e) {
                Debug.Print("Exception when calling StationApi.stationRegisterCreate: " + 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\StationApi();

try {
    $api_instance->stationRegisterCreate();
} catch (Exception $e) {
    echo 'Exception when calling StationApi->stationRegisterCreate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StationApi;

# 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::StationApi->new();

eval {
    $api_instance->stationRegisterCreate();
};
if ($@) {
    warn "Exception when calling StationApi->stationRegisterCreate: $@\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.StationApi()

try:
    api_instance.station_register_create()
except ApiException as e:
    print("Exception when calling StationApi->stationRegisterCreate: %s\n" % e)

extern crate StationApi;

pub fn main() {

    let mut context = StationApi::Context::default();
    let result = client.stationRegisterCreate(&context).wait();

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

Scopes

Parameters

Responses

Stations

stationsList

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=clientVersion_example&id=56&name=name_example&page=56&status=56"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StationsApi;

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

public class StationsApiExample {
    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
        StationsApi apiInstance = new StationsApi();
        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.stationsList(clientVersion, id, name, page, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StationsApi#stationsList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.StationsApi;

public class StationsApiExample {
    public static void main(String[] args) {
        StationsApi apiInstance = new StationsApi();
        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.stationsList(clientVersion, id, name, page, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StationsApi#stationsList");
            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
StationsApi *apiInstance = [[StationsApi 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 stationsListWith: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.StationsApi()
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.stationsList(opts, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class stationsListExample
    {
        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 StationsApi();
            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.stationsList(clientVersion, id, name, page, status);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StationsApi.stationsList: " + 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\StationsApi();
$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->stationsList($clientVersion, $id, $name, $page, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StationsApi->stationsList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StationsApi;

# 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::StationsApi->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->stationsList(clientVersion => $clientVersion, id => $id, name => $name, page => $page, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StationsApi->stationsList: $@\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.StationsApi()
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.stations_list(clientVersion=clientVersion, id=id, name=name, page=page, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StationsApi->stationsList: %s\n" % e)

extern crate StationsApi;

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 = StationsApi::Context::default();
    let result = client.stationsList(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

Schema

stationsRetrieve

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.StationsApi;

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

public class StationsApiExample {
    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
        StationsApi apiInstance = new StationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this station.

        try {
            Station result = apiInstance.stationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StationsApi#stationsRetrieve");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.StationsApi;

public class StationsApiExample {
    public static void main(String[] args) {
        StationsApi apiInstance = new StationsApi();
        Integer id = 56; // Integer | A unique integer value identifying this station.

        try {
            Station result = apiInstance.stationsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StationsApi#stationsRetrieve");
            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
StationsApi *apiInstance = [[StationsApi alloc] init];
Integer *id = 56; // A unique integer value identifying this station. (default to null)

[apiInstance stationsRetrieveWith: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.StationsApi()
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.stationsRetrieve(id, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class stationsRetrieveExample
    {
        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 StationsApi();
            var id = 56;  // Integer | A unique integer value identifying this station. (default to null)

            try {
                Station result = apiInstance.stationsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StationsApi.stationsRetrieve: " + 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\StationsApi();
$id = 56; // Integer | A unique integer value identifying this station.

try {
    $result = $api_instance->stationsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StationsApi->stationsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StationsApi;

# 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::StationsApi->new();
my $id = 56; # Integer | A unique integer value identifying this station.

eval {
    my $result = $api_instance->stationsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StationsApi->stationsRetrieve: $@\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.StationsApi()
id = 56 # Integer | A unique integer value identifying this station. (default to null)

try:
    api_response = api_instance.stations_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StationsApi->stationsRetrieve: %s\n" % e)

extern crate StationsApi;

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

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

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

Scopes

Parameters

Path parameters

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

Responses

Schema

Transmitters

transmittersList

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=56&uuid=uuid_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TransmittersApi;

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

public class TransmittersApiExample {
    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
        TransmittersApi apiInstance = new TransmittersApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        String uuid = uuid_example; // String | 

        try {
            PaginatedTransmitterList result = apiInstance.transmittersList(page, uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransmittersApi#transmittersList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.TransmittersApi;

public class TransmittersApiExample {
    public static void main(String[] args) {
        TransmittersApi apiInstance = new TransmittersApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        String uuid = uuid_example; // String | 

        try {
            PaginatedTransmitterList result = apiInstance.transmittersList(page, uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransmittersApi#transmittersList");
            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
TransmittersApi *apiInstance = [[TransmittersApi 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 transmittersListWith: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.TransmittersApi()
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.transmittersList(opts, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class transmittersListExample
    {
        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 TransmittersApi();
            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.transmittersList(page, uuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransmittersApi.transmittersList: " + 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\TransmittersApi();
$page = 56; // Integer | A page number within the paginated result set.
$uuid = uuid_example; // String | 

try {
    $result = $api_instance->transmittersList($page, $uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransmittersApi->transmittersList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransmittersApi;

# 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::TransmittersApi->new();
my $page = 56; # Integer | A page number within the paginated result set.
my $uuid = uuid_example; # String | 

eval {
    my $result = $api_instance->transmittersList(page => $page, uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransmittersApi->transmittersList: $@\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.TransmittersApi()
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.transmitters_list(page=page, uuid=uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransmittersApi->transmittersList: %s\n" % e)

extern crate TransmittersApi;

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

    let mut context = TransmittersApi::Context::default();
    let result = client.transmittersList(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

Schema

transmittersRetrieve

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.TransmittersApi;

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

public class TransmittersApiExample {
    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
        TransmittersApi apiInstance = new TransmittersApi();
        String transmitterUuid = transmitterUuid_example; // String | 

        try {
            Transmitter result = apiInstance.transmittersRetrieve(transmitterUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransmittersApi#transmittersRetrieve");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.TransmittersApi;

public class TransmittersApiExample {
    public static void main(String[] args) {
        TransmittersApi apiInstance = new TransmittersApi();
        String transmitterUuid = transmitterUuid_example; // String | 

        try {
            Transmitter result = apiInstance.transmittersRetrieve(transmitterUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransmittersApi#transmittersRetrieve");
            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
TransmittersApi *apiInstance = [[TransmittersApi alloc] init];
String *transmitterUuid = transmitterUuid_example; //  (default to null)

[apiInstance transmittersRetrieveWith: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.TransmittersApi()
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.transmittersRetrieve(transmitterUuid, callback);

using System;
using System.Diagnostics;
using satnogsnetworkapiclient.Api;
using satnogsnetworkapiclient.Client;
using satnogsnetworkapiclient.Model;

namespace Example
{
    public class transmittersRetrieveExample
    {
        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 TransmittersApi();
            var transmitterUuid = transmitterUuid_example;  // String |  (default to null)

            try {
                Transmitter result = apiInstance.transmittersRetrieve(transmitterUuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransmittersApi.transmittersRetrieve: " + 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\TransmittersApi();
$transmitterUuid = transmitterUuid_example; // String | 

try {
    $result = $api_instance->transmittersRetrieve($transmitterUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransmittersApi->transmittersRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TransmittersApi;

# 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::TransmittersApi->new();
my $transmitterUuid = transmitterUuid_example; # String | 

eval {
    my $result = $api_instance->transmittersRetrieve(transmitterUuid => $transmitterUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransmittersApi->transmittersRetrieve: $@\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.TransmittersApi()
transmitterUuid = transmitterUuid_example # String |  (default to null)

try:
    api_response = api_instance.transmitters_retrieve(transmitterUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransmittersApi->transmittersRetrieve: %s\n" % e)

extern crate TransmittersApi;

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

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

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

Scopes

Parameters

Path parameters

Name	Description
transmitter_uuid*	String Required

Responses

Schema

OpenAPI Sample

API and SDK Documentation

Configuration

configurationList

Usage and SDK Samples

Scopes

Parameters

Responses

configurationRetrieve

Usage and SDK Samples

Scopes

Parameters

Responses

Jobs

jobsList

Usage and SDK Samples

Scopes

Parameters

Responses

jobsRetrieve

Usage and SDK Samples

Scopes

Parameters

Responses

Observations

observationsCreate

Usage and SDK Samples

Scopes

Parameters

Responses

observationsList

Usage and SDK Samples

Scopes

Parameters

Responses

observationsPartialUpdate

Usage and SDK Samples

Scopes

Parameters

Responses

observationsRetrieve

Usage and SDK Samples

Scopes

Parameters

Responses

observationsUpdate

Usage and SDK Samples

Scopes

Parameters

Responses

Station

stationRegisterCreate

Usage and SDK Samples

Scopes

Parameters

Responses

Stations

stationsList

Usage and SDK Samples

Scopes

Parameters

Responses

stationsRetrieve

Usage and SDK Samples

Scopes

Parameters

Responses

Transmitters

transmittersList

Usage and SDK Samples

Scopes

Parameters

Responses

transmittersRetrieve

Usage and SDK Samples

Scopes

Parameters

Responses