webapi.lufthansa-s-22651.tst-dlh.next.fpocloud.pace.de Open in urlscan Pro
63.33.127.36  Public Scan

URL: https://webapi.lufthansa-s-22651.tst-dlh.next.fpocloud.pace.de/
Submission: On April 19 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

   
   
 * API Summary
 * API Methods - Avionics
 * customerAcarsPost
 * customerAidPost
 * customerAocPost
 * customerAcarsUplinkGet
 * API Methods - Flightplan
 * customerAtcPost
 * customerOfpGet
 * customerOfpPost
 * API Methods - Info
 * openapiGet
 * rootGet
 * API Methods - Other
 * customerOtherPost
 * customerPost
 * API Methods - Weather
 * customerGeojsonGet
 * customerUadGet


FPO CLOUD WEB API




API AND SDK DOCUMENTATION

Version: 1.3.0

--------------------------------------------------------------------------------

With this API users can upload flightplan, avionics and other data to FPO Cloud
as well as download generated weather files or modified flight plans.

To use this API users need a unique API key which must not be exposed to
unauthorized persons and a customer id to identify data in customer-specific
formats. The API key is used for authorization. It restricts the access to
eligible resources only. Specifically, only the customer can use his/her own
customer-specific resources


AVIONICS


CUSTOMERACARSPOST

Add customer-specific ACARS message to FPO Cloud











/{customer}/acars




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/{customer}/acars?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AvionicsApi;

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

public class AvionicsApiExample {

    public static void main(String[] args) {
        
        AvionicsApi apiInstance = new AvionicsApi();
        String body = ; // String | ACARS message in customer specific format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAcarsPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvionicsApi#customerAcarsPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AvionicsApi;

public class AvionicsApiExample {

    public static void main(String[] args) {
        AvionicsApi apiInstance = new AvionicsApi();
        String body = ; // String | ACARS message in customer specific format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAcarsPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvionicsApi#customerAcarsPost");
            e.printStackTrace();
        }
    }
}

String *body = ; // ACARS message in customer specific format
String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // optional id for this object, generated if not given (optional)

AvionicsApi *apiInstance = [[AvionicsApi alloc] init];

// Add customer-specific ACARS message to FPO Cloud
[apiInstance customerAcarsPostWith:body
    xApiKey:xApiKey
    customer:customer
    id:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.AvionicsApi()
var body = ; // {{String}} ACARS message in customer specific format
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var opts = { 
  'id': id_example // {{String}} optional id for this object, generated if not given
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerAcarsPost(bodyxApiKeycustomer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AvionicsApi();
            var body = new String(); // String | ACARS message in customer specific format
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | optional id for this object, generated if not given (optional) 

            try
            {
                // Add customer-specific ACARS message to FPO Cloud
                'String' result = apiInstance.customerAcarsPost(body, xApiKey, customer, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AvionicsApi.customerAcarsPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAvionicsApi();
$body = ; // String | ACARS message in customer specific format
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | optional id for this object, generated if not given

try {
    $result = $api_instance->customerAcarsPost($body, $xApiKey, $customer, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvionicsApi->customerAcarsPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AvionicsApi;

my $api_instance = WWW::SwaggerClient::AvionicsApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | ACARS message in customer specific format
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | optional id for this object, generated if not given

eval { 
    my $result = $api_instance->customerAcarsPost(body => $body, xApiKey => $xApiKey, customer => $customer, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvionicsApi->customerAcarsPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.AvionicsApi()
body =  # String | ACARS message in customer specific format
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | optional id for this object, generated if not given (optional)

try: 
    # Add customer-specific ACARS message to FPO Cloud
    api_response = api_instance.customer_acars_post(body, xApiKey, customer, id=id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvionicsApi->customerAcarsPost: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Body parameters

Name Description body *


Query parameters

Name Description id
String
optional id for this object, generated if not given


RESPONSES


STATUS: 202 - THE DATA WAS ACCEPTED BUT NOT YET PROCESSED. RETURNS ID OF CREATED
OBJECT

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


CUSTOMERAIDPOST

Add AID Stream message to FPO Cloud











/{customer}/aid




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/{customer}/aid?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AvionicsApi;

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

public class AvionicsApiExample {

    public static void main(String[] args) {
        
        AvionicsApi apiInstance = new AvionicsApi();
        String body = ; // String | AID Stream message in json format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAidPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvionicsApi#customerAidPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AvionicsApi;

public class AvionicsApiExample {

    public static void main(String[] args) {
        AvionicsApi apiInstance = new AvionicsApi();
        String body = ; // String | AID Stream message in json format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAidPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvionicsApi#customerAidPost");
            e.printStackTrace();
        }
    }
}

String *body = ; // AID Stream message in json format
String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // optional id for this object, generated if not given (optional)

AvionicsApi *apiInstance = [[AvionicsApi alloc] init];

// Add AID Stream message to FPO Cloud
[apiInstance customerAidPostWith:body
    xApiKey:xApiKey
    customer:customer
    id:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.AvionicsApi()
var body = ; // {{String}} AID Stream message in json format
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var opts = { 
  'id': id_example // {{String}} optional id for this object, generated if not given
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerAidPost(bodyxApiKeycustomer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AvionicsApi();
            var body = new String(); // String | AID Stream message in json format
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | optional id for this object, generated if not given (optional) 

            try
            {
                // Add AID Stream message to FPO Cloud
                'String' result = apiInstance.customerAidPost(body, xApiKey, customer, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AvionicsApi.customerAidPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAvionicsApi();
$body = ; // String | AID Stream message in json format
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | optional id for this object, generated if not given

try {
    $result = $api_instance->customerAidPost($body, $xApiKey, $customer, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvionicsApi->customerAidPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AvionicsApi;

my $api_instance = WWW::SwaggerClient::AvionicsApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | AID Stream message in json format
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | optional id for this object, generated if not given

eval { 
    my $result = $api_instance->customerAidPost(body => $body, xApiKey => $xApiKey, customer => $customer, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvionicsApi->customerAidPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.AvionicsApi()
body =  # String | AID Stream message in json format
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | optional id for this object, generated if not given (optional)

try: 
    # Add AID Stream message to FPO Cloud
    api_response = api_instance.customer_aid_post(body, xApiKey, customer, id=id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvionicsApi->customerAidPost: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Body parameters

Name Description body *


Query parameters

Name Description id
String
optional id for this object, generated if not given


RESPONSES


STATUS: 202 - THE DATA WAS ACCEPTED BUT NOT YET PROCESSED. RETURNS ID OF CREATED
OBJECT

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


CUSTOMERAOCPOST

Add PACE AOC message to FPO Cloud











/{customer}/aoc




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/{customer}/aoc?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AvionicsApi;

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

public class AvionicsApiExample {

    public static void main(String[] args) {
        
        AvionicsApi apiInstance = new AvionicsApi();
        String body = ; // String | PACE AOC message in text format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAocPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvionicsApi#customerAocPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AvionicsApi;

public class AvionicsApiExample {

    public static void main(String[] args) {
        AvionicsApi apiInstance = new AvionicsApi();
        String body = ; // String | PACE AOC message in text format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAocPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvionicsApi#customerAocPost");
            e.printStackTrace();
        }
    }
}

String *body = ; // PACE AOC message in text format
String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // optional id for this object, generated if not given (optional)

AvionicsApi *apiInstance = [[AvionicsApi alloc] init];

// Add PACE AOC message to FPO Cloud
[apiInstance customerAocPostWith:body
    xApiKey:xApiKey
    customer:customer
    id:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.AvionicsApi()
var body = ; // {{String}} PACE AOC message in text format
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var opts = { 
  'id': id_example // {{String}} optional id for this object, generated if not given
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerAocPost(bodyxApiKeycustomer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AvionicsApi();
            var body = new String(); // String | PACE AOC message in text format
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | optional id for this object, generated if not given (optional) 

            try
            {
                // Add PACE AOC message to FPO Cloud
                'String' result = apiInstance.customerAocPost(body, xApiKey, customer, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AvionicsApi.customerAocPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAvionicsApi();
$body = ; // String | PACE AOC message in text format
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | optional id for this object, generated if not given

try {
    $result = $api_instance->customerAocPost($body, $xApiKey, $customer, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvionicsApi->customerAocPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AvionicsApi;

my $api_instance = WWW::SwaggerClient::AvionicsApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | PACE AOC message in text format
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | optional id for this object, generated if not given

eval { 
    my $result = $api_instance->customerAocPost(body => $body, xApiKey => $xApiKey, customer => $customer, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvionicsApi->customerAocPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.AvionicsApi()
body =  # String | PACE AOC message in text format
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | optional id for this object, generated if not given (optional)

try: 
    # Add PACE AOC message to FPO Cloud
    api_response = api_instance.customer_aoc_post(body, xApiKey, customer, id=id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvionicsApi->customerAocPost: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Body parameters

Name Description body *


Query parameters

Name Description id
String
optional id for this object, generated if not given


RESPONSES


STATUS: 202 - THE DATA WAS ACCEPTED BUT NOT YET PROCESSED. RETURNS ID OF CREATED
OBJECT

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR




CUSTOMERACARSUPLINKGET

Fetch Acars message from FPO Cloud











/{customer}/acarsuplink




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X GET "https://api.fpocloud-trial.com/v1/{customer}/acarsuplink"

import io.swagger.client.*;
                      import io.swagger.client.auth.*;
                      import io.swagger.client.model.*;
                      import io.swagger.client.api.AvionicsApi;
                      
                      import java.io.File;
                      import java.util.*;
                      
                      public class AvionicsApiExample {
                      
                      public static void main(String[] args) {
                      
                      AvionicsApi apiInstance = new AvionicsApi();
                      String body = ; // String | PACE AOC message in text format
                      String xApiKey = xApiKey_example; // String | customer specific API key
                      String customer = customer_example; // String | customer id, all lower case
                      String id = id_example; // String | optional id for this object, generated if not given
                      try {
                      'String' result = apiInstance.customerAcarsUplinkGet(body, xApiKey, customer, id);
                      System.out.println(result);
                      } catch (ApiException e) {
                      System.err.println("Exception when calling AvionicsApi#customerAcarsUplinkGet");
                      e.printStackTrace();
                      }
                      }
                      }

import io.swagger.client.api.AvionicsApi;
                      
                      public class AvionicsApiExample {
                      
                      public static void main(String[] args) {
                      AvionicsApi apiInstance = new AvionicsApi();
                      String xApiKey = xApiKey_example; // String | customer specific API key
                      String customer = customer_example; // String | customer id, all lower case
                      String id = id_example; // String | optional id for this object, generated if not given
                      try {
                      'String' result = apiInstance.customerAcarsUplinkGet(body, xApiKey, customer, id);
                      System.out.println(result);
                      } catch (ApiException e) {
                      System.err.println("Exception when calling AvionicsApi#customerAcarsUplinkGet");
                      e.printStackTrace();
                      }
                      }
                      }

String *body = ; // PACE AOC message in text format
                      String *xApiKey = xApiKey_example; // customer specific API key
                      String *customer = customer_example; // customer id, all lower case
                      String *id = id_example; // optional id for this object, generated if not given (optional)
                      
                      AvionicsApi *apiInstance = [[AvionicsApi alloc] init];
                      
                      // Fetch Acars message from FPO Cloud
                      [apiInstance customerAcarsUplinkGetWith:body
                      xApiKey:xApiKey
                      customer:customer
                      id:id
                      completionHandler: ^('String' output, NSError* error) {
                              if (output) {
                                  NSLog(@"%@", output);
                              }
                              if (error) {
                                  NSLog(@"Error: %@", error);
                              }
                          }];
                      

var FpoCloudWebApi = require('fpo_cloud_web_api');
                      
                      var api = new FpoCloudWebApi.AvionicsApi()
                      var xApiKey = xApiKey_example; // {{String}} customer specific API key
                      var customer = customer_example; // {{String}} customer id, all lower case
                      var opts = { 
                      'id': id_example // {{String}} optional id for this object, generated if not given
                      };
                      var callback = function(error, data, response) {
                      if (error) {
                      console.error(error);
                      } else {
                      console.log('API called successfully. Returned data: ' + data);
                      }
                      };
                      api.customerAcarsUplinkGet(bodyxApiKeycustomer, opts, callback);
                      

using System;
                      using System.Diagnostics;
                      using IO.Swagger.Api;
                      using IO.Swagger.Client;
                      using IO.Swagger.Model;
                      
                      namespace Example
                      {
                      public class customerAcarsUplinkGetExample
                      {
                      public void main()
                      {
                      
                      var apiInstance = new AvionicsApi();
                      var xApiKey = xApiKey_example;  // String | customer specific API key
                      var customer = customer_example;  // String | customer id, all lower case
                      var id = id_example;  // String | optional id for this object, generated if not given (optional) 
                      
                      try
                      {
                      // Fetch Acars message from FPO Cloud
                      'String' result = apiInstance.customerAcarsUplinkGet(body, xApiKey, customer, id);
                      Debug.WriteLine(result);
                      }
                      catch (Exception e)
                      {
                      Debug.Print("Exception when calling AvionicsApi.customerAcarsUplinkGet: " + e.Message );
                      }
                      }
                      }
                      }
                      

<?php
                      require_once(__DIR__ . '/vendor/autoload.php');
                      
                      $api_instance = new Swagger\Client\ApiAvionicsApi();
                      $xApiKey = xApiKey_example; // String | customer specific API key
                      $customer = customer_example; // String | customer id, all lower case
                      $id = id_example; // String | optional id for this object, generated if not given
                      
                      try {
                      $result = $api_instance->customerAcarsUplinkGet($body, $xApiKey, $customer, $id);
                      print_r($result);
                      } catch (Exception $e) {
                      echo 'Exception when calling AvionicsApi->customerAcarsUplinkGet: ', $e->getMessage(), PHP_EOL;
                      }
                      ?>

use Data::Dumper;
                      use WWW::SwaggerClient::Configuration;
                      use WWW::SwaggerClient::AvionicsApi;
                      
                      my $api_instance = WWW::SwaggerClient::AvionicsApi->new();
                      my $xApiKey = xApiKey_example; # String | customer specific API key
                      my $customer = customer_example; # String | customer id, all lower case
                      my $id = id_example; # String | optional id for this object, generated if not given
                      
                      eval { 
                      my $result = $api_instance->customerAcarsUplinkGet(body => $body, xApiKey => $xApiKey, customer => $customer, id => $id);
                      print Dumper($result);
                      };
                      if ($@) {
                      warn "Exception when calling AvionicsApi->customerAcarsUplinkGet: $@\n";
                      }

from __future__ import print_statement
                      import time
                      import swagger_client
                      from swagger_client.rest import ApiException
                      from pprint import pprint
                      
                      # create an instance of the API class
                      api_instance = swagger_client.AvionicsApi()
                      xApiKey = xApiKey_example # String | customer specific API key
                      customer = customer_example # String | customer id, all lower case
                      id = id_example # String | optional id for this object, generated if not given (optional)
                      
                      try: 
                      # Fetch Acars message from FPO Cloud
                      api_response = api_instance.customer_aoc_post(body, xApiKey, customer, id=id)
                      pprint(api_response)
                      except ApiException as e:
                      print("Exception when calling AvionicsApi->customerAcarsUplinkGet: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Query parameters

Name Description flightId
String
optional flightId for acars message, returns all acars if not specified


RESPONSES


STATUS: 200 - OK

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


FLIGHTPLAN


CUSTOMERATCPOST

Add an ATC Flight plan to FPO Cloud











/{customer}/atc




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/{customer}/atc?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlightplanApi;

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

public class FlightplanApiExample {

    public static void main(String[] args) {
        
        FlightplanApi apiInstance = new FlightplanApi();
        String body = ; // String | ATC Flight plan in customer specific format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAtcPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlightplanApi#customerAtcPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlightplanApi;

public class FlightplanApiExample {

    public static void main(String[] args) {
        FlightplanApi apiInstance = new FlightplanApi();
        String body = ; // String | ATC Flight plan in customer specific format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerAtcPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlightplanApi#customerAtcPost");
            e.printStackTrace();
        }
    }
}

String *body = ; // ATC Flight plan in customer specific format
String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // optional id for this object, generated if not given (optional)

FlightplanApi *apiInstance = [[FlightplanApi alloc] init];

// Add an ATC Flight plan to FPO Cloud
[apiInstance customerAtcPostWith:body
    xApiKey:xApiKey
    customer:customer
    id:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.FlightplanApi()
var body = ; // {{String}} ATC Flight plan in customer specific format
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var opts = { 
  'id': id_example // {{String}} optional id for this object, generated if not given
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerAtcPost(bodyxApiKeycustomer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new FlightplanApi();
            var body = new String(); // String | ATC Flight plan in customer specific format
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | optional id for this object, generated if not given (optional) 

            try
            {
                // Add an ATC Flight plan to FPO Cloud
                'String' result = apiInstance.customerAtcPost(body, xApiKey, customer, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlightplanApi.customerAtcPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiFlightplanApi();
$body = ; // String | ATC Flight plan in customer specific format
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | optional id for this object, generated if not given

try {
    $result = $api_instance->customerAtcPost($body, $xApiKey, $customer, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlightplanApi->customerAtcPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlightplanApi;

my $api_instance = WWW::SwaggerClient::FlightplanApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | ATC Flight plan in customer specific format
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | optional id for this object, generated if not given

eval { 
    my $result = $api_instance->customerAtcPost(body => $body, xApiKey => $xApiKey, customer => $customer, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlightplanApi->customerAtcPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.FlightplanApi()
body =  # String | ATC Flight plan in customer specific format
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | optional id for this object, generated if not given (optional)

try: 
    # Add an ATC Flight plan to FPO Cloud
    api_response = api_instance.customer_atc_post(body, xApiKey, customer, id=id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlightplanApi->customerAtcPost: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Body parameters

Name Description body *


Query parameters

Name Description id
String
optional id for this object, generated if not given


RESPONSES


STATUS: 202 - THE DATA WAS ACCEPTED BUT NOT YET PROCESSED. RETURNS ID OF CREATED
OBJECT

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


CUSTOMEROFPGET

Get an OFP in ARINC 633 XML format from FPO Cloud











/{customer}/ofp




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X GET "https://api.fpocloud-trial.com/v1/{customer}/ofp?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlightplanApi;

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

public class FlightplanApiExample {

    public static void main(String[] args) {
        
        FlightplanApi apiInstance = new FlightplanApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
        try {
            apiInstance.customerOfpGet(xApiKey, customer, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlightplanApi#customerOfpGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlightplanApi;

public class FlightplanApiExample {

    public static void main(String[] args) {
        FlightplanApi apiInstance = new FlightplanApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
        try {
            apiInstance.customerOfpGet(xApiKey, customer, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlightplanApi#customerOfpGet");
            e.printStackTrace();
        }
    }
}

String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // id for this object, must be identical to the id of a previously uploaded OFP

FlightplanApi *apiInstance = [[FlightplanApi alloc] init];

// Get an OFP in ARINC 633 XML format from FPO Cloud
[apiInstance customerOfpGetWith:xApiKey
    customer:customer
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.FlightplanApi()
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var id = id_example; // {{String}} id for this object, must be identical to the id of a previously uploaded OFP

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.customerOfpGet(xApiKey, customer, id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new FlightplanApi();
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | id for this object, must be identical to the id of a previously uploaded OFP

            try
            {
                // Get an OFP in ARINC 633 XML format from FPO Cloud
                apiInstance.customerOfpGet(xApiKey, customer, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlightplanApi.customerOfpGet: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiFlightplanApi();
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP

try {
    $api_instance->customerOfpGet($xApiKey, $customer, $id);
} catch (Exception $e) {
    echo 'Exception when calling FlightplanApi->customerOfpGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlightplanApi;

my $api_instance = WWW::SwaggerClient::FlightplanApi->new();
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | id for this object, must be identical to the id of a previously uploaded OFP

eval { 
    $api_instance->customerOfpGet(xApiKey => $xApiKey, customer => $customer, id => $id);
};
if ($@) {
    warn "Exception when calling FlightplanApi->customerOfpGet: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.FlightplanApi()
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | id for this object, must be identical to the id of a previously uploaded OFP

try: 
    # Get an OFP in ARINC 633 XML format from FPO Cloud
    api_instance.customer_ofp_get(xApiKey, customer, id)
except ApiException as e:
    print("Exception when calling FlightplanApi->customerOfpGet: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Query parameters

Name Description id*
String
id for this object, must be identical to the id of a previously uploaded OFP
Required


RESPONSES


STATUS: 200 - OK




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


CUSTOMEROFPPOST

Add an OFP in ARINC 633 or customer specific format to FPO Cloud











/{customer}/ofp




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/{customer}/ofp?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlightplanApi;

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

public class FlightplanApiExample {

    public static void main(String[] args) {
        
        FlightplanApi apiInstance = new FlightplanApi();
        String body = ; // String | Flight plan in Arinc 633 XML or customer specific format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerOfpPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlightplanApi#customerOfpPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FlightplanApi;

public class FlightplanApiExample {

    public static void main(String[] args) {
        FlightplanApi apiInstance = new FlightplanApi();
        String body = ; // String | Flight plan in Arinc 633 XML or customer specific format
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | optional id for this object, generated if not given
        try {
            'String' result = apiInstance.customerOfpPost(body, xApiKey, customer, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlightplanApi#customerOfpPost");
            e.printStackTrace();
        }
    }
}

String *body = ; // Flight plan in Arinc 633 XML or customer specific format
String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // optional id for this object, generated if not given (optional)

FlightplanApi *apiInstance = [[FlightplanApi alloc] init];

// Add an OFP in ARINC 633 or customer specific format to FPO Cloud
[apiInstance customerOfpPostWith:body
    xApiKey:xApiKey
    customer:customer
    id:id
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.FlightplanApi()
var body = ; // {{String}} Flight plan in Arinc 633 XML or customer specific format
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var opts = { 
  'id': id_example // {{String}} optional id for this object, generated if not given
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerOfpPost(bodyxApiKeycustomer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new FlightplanApi();
            var body = new String(); // String | Flight plan in Arinc 633 XML or customer specific format
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | optional id for this object, generated if not given (optional) 

            try
            {
                // Add an OFP in ARINC 633 or customer specific format to FPO Cloud
                'String' result = apiInstance.customerOfpPost(body, xApiKey, customer, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlightplanApi.customerOfpPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiFlightplanApi();
$body = ; // String | Flight plan in Arinc 633 XML or customer specific format
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | optional id for this object, generated if not given

try {
    $result = $api_instance->customerOfpPost($body, $xApiKey, $customer, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlightplanApi->customerOfpPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlightplanApi;

my $api_instance = WWW::SwaggerClient::FlightplanApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | Flight plan in Arinc 633 XML or customer specific format
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | optional id for this object, generated if not given

eval { 
    my $result = $api_instance->customerOfpPost(body => $body, xApiKey => $xApiKey, customer => $customer, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlightplanApi->customerOfpPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.FlightplanApi()
body =  # String | Flight plan in Arinc 633 XML or customer specific format
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | optional id for this object, generated if not given (optional)

try: 
    # Add an OFP in ARINC 633 or customer specific format to FPO Cloud
    api_response = api_instance.customer_ofp_post(body, xApiKey, customer, id=id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlightplanApi->customerOfpPost: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Body parameters

Name Description body *


Query parameters

Name Description id
String
optional id for this object, generated if not given


RESPONSES


STATUS: 202 - THE DATA WAS ACCEPTED BUT NOT YET PROCESSED. RETURNS ID OF CREATED
OBJECT

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


INFO


OPENAPIGET

Download this API specification as an OpenAPI 3.0 JSON file











/openapi




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X GET "https://api.fpocloud-trial.com/v1/openapi"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfoApi;

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

public class InfoApiExample {

    public static void main(String[] args) {
        
        InfoApi apiInstance = new InfoApi();
        try {
            Object result = apiInstance.openapiGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfoApi#openapiGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InfoApi;

public class InfoApiExample {

    public static void main(String[] args) {
        InfoApi apiInstance = new InfoApi();
        try {
            Object result = apiInstance.openapiGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfoApi#openapiGet");
            e.printStackTrace();
        }
    }
}


InfoApi *apiInstance = [[InfoApi alloc] init];

// Download this API specification as an OpenAPI 3.0 JSON file
[apiInstance openapiGetWithCompletionHandler: 
              ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InfoApi();

            try
            {
                // Download this API specification as an OpenAPI 3.0 JSON file
                Object result = apiInstance.openapiGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfoApi.openapiGet: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiInfoApi();

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfoApi;

my $api_instance = WWW::SwaggerClient::InfoApi->new();

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

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

# create an instance of the API class
api_instance = swagger_client.InfoApi()

try: 
    # Download this API specification as an OpenAPI 3.0 JSON file
    api_response = api_instance.openapi_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfoApi->openapiGet: %s\n" % e)


PARAMETERS


RESPONSES


STATUS: 200 - OK

 * Schema
 * Headers

Name Type Format Description Content-Disposition String


STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


ROOTGET

OpenAPI 3.0 specification for FPO Cloud Web API in HTML format











/




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X GET "https://api.fpocloud-trial.com/v1/"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfoApi;

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

public class InfoApiExample {

    public static void main(String[] args) {
        
        InfoApi apiInstance = new InfoApi();
        try {
            apiInstance.rootGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling InfoApi#rootGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InfoApi;

public class InfoApiExample {

    public static void main(String[] args) {
        InfoApi apiInstance = new InfoApi();
        try {
            apiInstance.rootGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling InfoApi#rootGet");
            e.printStackTrace();
        }
    }
}


InfoApi *apiInstance = [[InfoApi alloc] init];

// OpenAPI 3.0 specification for FPO Cloud Web API in HTML format
[apiInstance rootGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.InfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.rootGet(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new InfoApi();

            try
            {
                // OpenAPI 3.0 specification for FPO Cloud Web API in HTML format
                apiInstance.rootGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfoApi.rootGet: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiInfoApi();

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfoApi;

my $api_instance = WWW::SwaggerClient::InfoApi->new();

eval { 
    $api_instance->rootGet();
};
if ($@) {
    warn "Exception when calling InfoApi->rootGet: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.InfoApi()

try: 
    # OpenAPI 3.0 specification for FPO Cloud Web API in HTML format
    api_instance.root_get()
except ApiException as e:
    print("Exception when calling InfoApi->rootGet: %s\n" % e)


PARAMETERS


RESPONSES


STATUS: 200 - OK




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


OTHER


CUSTOMEROTHERPOST

Add other customer-specific data to FPO Cloud











/{customer}/other




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/{customer}/other"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OtherApi;

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

public class OtherApiExample {

    public static void main(String[] args) {
        
        OtherApi apiInstance = new OtherApi();
        String body = ; // String | Any customer data
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        try {
            'String' result = apiInstance.customerOtherPost(body, xApiKey, customer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#customerOtherPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OtherApi;

public class OtherApiExample {

    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();
        String body = ; // String | Any customer data
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        try {
            'String' result = apiInstance.customerOtherPost(body, xApiKey, customer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#customerOtherPost");
            e.printStackTrace();
        }
    }
}

String *body = ; // Any customer data
String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case

OtherApi *apiInstance = [[OtherApi alloc] init];

// Add other customer-specific data to FPO Cloud
[apiInstance customerOtherPostWith:body
    xApiKey:xApiKey
    customer:customer
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.OtherApi()
var body = ; // {{String}} Any customer data
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OtherApi();
            var body = new String(); // String | Any customer data
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case

            try
            {
                // Add other customer-specific data to FPO Cloud
                'String' result = apiInstance.customerOtherPost(body, xApiKey, customer);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OtherApi.customerOtherPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiOtherApi();
$body = ; // String | Any customer data
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case

try {
    $result = $api_instance->customerOtherPost($body, $xApiKey, $customer);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->customerOtherPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OtherApi;

my $api_instance = WWW::SwaggerClient::OtherApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | Any customer data
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case

eval { 
    my $result = $api_instance->customerOtherPost(body => $body, xApiKey => $xApiKey, customer => $customer);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->customerOtherPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.OtherApi()
body =  # String | Any customer data
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case

try: 
    # Add other customer-specific data to FPO Cloud
    api_response = api_instance.customer_other_post(body, xApiKey, customer)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->customerOtherPost: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required

Body parameters

Name Description body *



RESPONSES


STATUS: 202 - THE DATA WAS ACCEPTED BUT NOT YET PROCESSED. RETURNS ID OF CREATED
OBJECT

 * Schema




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


CUSTOMERPOST

Internal use only!











/customer




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X POST "https://api.fpocloud-trial.com/v1/customer"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OtherApi;

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

public class OtherApiExample {

    public static void main(String[] args) {
        
        OtherApi apiInstance = new OtherApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        try {
            apiInstance.customerPost(xApiKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#customerPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OtherApi;

public class OtherApiExample {

    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        try {
            apiInstance.customerPost(xApiKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#customerPost");
            e.printStackTrace();
        }
    }
}

String *xApiKey = xApiKey_example; // customer specific API key

OtherApi *apiInstance = [[OtherApi alloc] init];

// Internal use only!
[apiInstance customerPostWith:xApiKey
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.OtherApi()
var xApiKey = xApiKey_example; // {{String}} customer specific API key

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.customerPost(xApiKey, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OtherApi();
            var xApiKey = xApiKey_example;  // String | customer specific API key

            try
            {
                // Internal use only!
                apiInstance.customerPost(xApiKey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OtherApi.customerPost: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiOtherApi();
$xApiKey = xApiKey_example; // String | customer specific API key

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OtherApi;

my $api_instance = WWW::SwaggerClient::OtherApi->new();
my $xApiKey = xApiKey_example; # String | customer specific API key

eval { 
    $api_instance->customerPost(xApiKey => $xApiKey);
};
if ($@) {
    warn "Exception when calling OtherApi->customerPost: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.OtherApi()
xApiKey = xApiKey_example # String | customer specific API key

try: 
    # Internal use only!
    api_instance.customer_post(xApiKey)
except ApiException as e:
    print("Exception when calling OtherApi->customerPost: %s\n" % e)


PARAMETERS

Header parameters

Name Description x-api-key*
String
customer specific API key
Required


RESPONSES


STATUS: 200 - THE DATA WAS SUCCESSFULLY PROCESSED AND A RESULT WAS CREATED




STATUS: 400 - THE REQUEST DATA WAS MALFORMED

 * Schema




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


WEATHER


CUSTOMERGEOJSONGET

Returns turbulence data as a GeoJSON file











/{customer}/geojson




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X GET "https://api.fpocloud-trial.com/v1/{customer}/geojson?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WeatherApi;

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

public class WeatherApiExample {

    public static void main(String[] args) {
        
        WeatherApi apiInstance = new WeatherApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
        String ifModifiedSince = ifModifiedSince_example; // String | Date in RFC 1123 format, to be used for Response 304 Not Modified
        try {
            apiInstance.customerGeojsonGet(xApiKey, customer, id, ifModifiedSince);
        } catch (ApiException e) {
            System.err.println("Exception when calling WeatherApi#customerGeojsonGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WeatherApi;

public class WeatherApiExample {

    public static void main(String[] args) {
        WeatherApi apiInstance = new WeatherApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
        String ifModifiedSince = ifModifiedSince_example; // String | Date in RFC 1123 format, to be used for Response 304 Not Modified
        try {
            apiInstance.customerGeojsonGet(xApiKey, customer, id, ifModifiedSince);
        } catch (ApiException e) {
            System.err.println("Exception when calling WeatherApi#customerGeojsonGet");
            e.printStackTrace();
        }
    }
}

String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // id for this object, must be identical to the id of a previously uploaded OFP
String *ifModifiedSince = ifModifiedSince_example; // Date in RFC 1123 format, to be used for Response 304 Not Modified (optional)

WeatherApi *apiInstance = [[WeatherApi alloc] init];

// Returns turbulence data as a GeoJSON file
[apiInstance customerGeojsonGetWith:xApiKey
    customer:customer
    id:id
    ifModifiedSince:ifModifiedSince
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.WeatherApi()
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var id = id_example; // {{String}} id for this object, must be identical to the id of a previously uploaded OFP
var opts = { 
  'ifModifiedSince': ifModifiedSince_example // {{String}} Date in RFC 1123 format, to be used for Response 304 Not Modified
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.customerGeojsonGet(xApiKey, customer, id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new WeatherApi();
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | id for this object, must be identical to the id of a previously uploaded OFP
            var ifModifiedSince = ifModifiedSince_example;  // String | Date in RFC 1123 format, to be used for Response 304 Not Modified (optional) 

            try
            {
                // Returns turbulence data as a GeoJSON file
                apiInstance.customerGeojsonGet(xApiKey, customer, id, ifModifiedSince);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WeatherApi.customerGeojsonGet: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiWeatherApi();
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
$ifModifiedSince = ifModifiedSince_example; // String | Date in RFC 1123 format, to be used for Response 304 Not Modified

try {
    $api_instance->customerGeojsonGet($xApiKey, $customer, $id, $ifModifiedSince);
} catch (Exception $e) {
    echo 'Exception when calling WeatherApi->customerGeojsonGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WeatherApi;

my $api_instance = WWW::SwaggerClient::WeatherApi->new();
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | id for this object, must be identical to the id of a previously uploaded OFP
my $ifModifiedSince = ifModifiedSince_example; # String | Date in RFC 1123 format, to be used for Response 304 Not Modified

eval { 
    $api_instance->customerGeojsonGet(xApiKey => $xApiKey, customer => $customer, id => $id, ifModifiedSince => $ifModifiedSince);
};
if ($@) {
    warn "Exception when calling WeatherApi->customerGeojsonGet: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.WeatherApi()
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | id for this object, must be identical to the id of a previously uploaded OFP
ifModifiedSince = ifModifiedSince_example # String | Date in RFC 1123 format, to be used for Response 304 Not Modified (optional)

try: 
    # Returns turbulence data as a GeoJSON file
    api_instance.customer_geojson_get(xApiKey, customer, id, ifModifiedSince=ifModifiedSince)
except ApiException as e:
    print("Exception when calling WeatherApi->customerGeojsonGet: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required
if-modified-since
String
Date in RFC 1123 format, to be used for Response 304 Not Modified

Query parameters

Name Description id*
String
id for this object, must be identical to the id of a previously uploaded OFP
Required


RESPONSES


STATUS: 200 - RESPONSE BODY IS A TURBULENCE FILE IN GEOJSON FORMAT

 * Headers

Name Type Format Description Last-Modified String


STATUS: 304 - THE SPECIFIED RESOURCE WAS NOT MODIFIED AFTER
<B>IF-MODIFIED-SINCE</B> DATE FROM REQUEST HEADER




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------


CUSTOMERUADGET

Returns Arinc 633 Upper Air Data created from OFP











/{customer}/uad




USAGE AND SDK SAMPLES



 * Curl
 * Java
 * Android
   
 * Obj-C
 * JavaScript
   
 * C#
 * PHP
 * Perl
 * Python

curl -X GET "https://api.fpocloud-trial.com/v1/{customer}/uad?id="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WeatherApi;

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

public class WeatherApiExample {

    public static void main(String[] args) {
        
        WeatherApi apiInstance = new WeatherApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
        String ifModifiedSince = ifModifiedSince_example; // String | Date in RFC 1123 format, to be used for Response 304 Not Modified
        try {
            apiInstance.customerUadGet(xApiKey, customer, id, ifModifiedSince);
        } catch (ApiException e) {
            System.err.println("Exception when calling WeatherApi#customerUadGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WeatherApi;

public class WeatherApiExample {

    public static void main(String[] args) {
        WeatherApi apiInstance = new WeatherApi();
        String xApiKey = xApiKey_example; // String | customer specific API key
        String customer = customer_example; // String | customer id, all lower case
        String id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
        String ifModifiedSince = ifModifiedSince_example; // String | Date in RFC 1123 format, to be used for Response 304 Not Modified
        try {
            apiInstance.customerUadGet(xApiKey, customer, id, ifModifiedSince);
        } catch (ApiException e) {
            System.err.println("Exception when calling WeatherApi#customerUadGet");
            e.printStackTrace();
        }
    }
}

String *xApiKey = xApiKey_example; // customer specific API key
String *customer = customer_example; // customer id, all lower case
String *id = id_example; // id for this object, must be identical to the id of a previously uploaded OFP
String *ifModifiedSince = ifModifiedSince_example; // Date in RFC 1123 format, to be used for Response 304 Not Modified (optional)

WeatherApi *apiInstance = [[WeatherApi alloc] init];

// Returns Arinc 633 Upper Air Data created from OFP
[apiInstance customerUadGetWith:xApiKey
    customer:customer
    id:id
    ifModifiedSince:ifModifiedSince
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var FpoCloudWebApi = require('fpo_cloud_web_api');

var api = new FpoCloudWebApi.WeatherApi()
var xApiKey = xApiKey_example; // {{String}} customer specific API key
var customer = customer_example; // {{String}} customer id, all lower case
var id = id_example; // {{String}} id for this object, must be identical to the id of a previously uploaded OFP
var opts = { 
  'ifModifiedSince': ifModifiedSince_example // {{String}} Date in RFC 1123 format, to be used for Response 304 Not Modified
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.customerUadGet(xApiKey, customer, id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new WeatherApi();
            var xApiKey = xApiKey_example;  // String | customer specific API key
            var customer = customer_example;  // String | customer id, all lower case
            var id = id_example;  // String | id for this object, must be identical to the id of a previously uploaded OFP
            var ifModifiedSince = ifModifiedSince_example;  // String | Date in RFC 1123 format, to be used for Response 304 Not Modified (optional) 

            try
            {
                // Returns Arinc 633 Upper Air Data created from OFP
                apiInstance.customerUadGet(xApiKey, customer, id, ifModifiedSince);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WeatherApi.customerUadGet: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiWeatherApi();
$xApiKey = xApiKey_example; // String | customer specific API key
$customer = customer_example; // String | customer id, all lower case
$id = id_example; // String | id for this object, must be identical to the id of a previously uploaded OFP
$ifModifiedSince = ifModifiedSince_example; // String | Date in RFC 1123 format, to be used for Response 304 Not Modified

try {
    $api_instance->customerUadGet($xApiKey, $customer, $id, $ifModifiedSince);
} catch (Exception $e) {
    echo 'Exception when calling WeatherApi->customerUadGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WeatherApi;

my $api_instance = WWW::SwaggerClient::WeatherApi->new();
my $xApiKey = xApiKey_example; # String | customer specific API key
my $customer = customer_example; # String | customer id, all lower case
my $id = id_example; # String | id for this object, must be identical to the id of a previously uploaded OFP
my $ifModifiedSince = ifModifiedSince_example; # String | Date in RFC 1123 format, to be used for Response 304 Not Modified

eval { 
    $api_instance->customerUadGet(xApiKey => $xApiKey, customer => $customer, id => $id, ifModifiedSince => $ifModifiedSince);
};
if ($@) {
    warn "Exception when calling WeatherApi->customerUadGet: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.WeatherApi()
xApiKey = xApiKey_example # String | customer specific API key
customer = customer_example # String | customer id, all lower case
id = id_example # String | id for this object, must be identical to the id of a previously uploaded OFP
ifModifiedSince = ifModifiedSince_example # String | Date in RFC 1123 format, to be used for Response 304 Not Modified (optional)

try: 
    # Returns Arinc 633 Upper Air Data created from OFP
    api_instance.customer_uad_get(xApiKey, customer, id, ifModifiedSince=ifModifiedSince)
except ApiException as e:
    print("Exception when calling WeatherApi->customerUadGet: %s\n" % e)


PARAMETERS

Path parameters

Name Description customer*
String
customer id, all lower case
Required

Header parameters

Name Description x-api-key*
String
customer specific API key
Required
if-modified-since
String
Date in RFC 1123 format, to be used for Response 304 Not Modified

Query parameters

Name Description id*
String
id for this object, must be identical to the id of a previously uploaded OFP
Required


RESPONSES


STATUS: 200 - RESPONSE BODY IS AN ARINC 633 UPPER AIR DATA XML FILE

 * Headers

Name Type Format Description Last-Modified date date


STATUS: 304 - THE SPECIFIED RESOURCE WAS NOT MODIFIED AFTER
<B>IF-MODIFIED-SINCE</B> DATE FROM REQUEST HEADER




STATUS: 401 - MISSING, WRONG OR EXPIRED API KEY

 * Schema
 * Headers

Name Type Format Description WWW_Authenticate String


STATUS: 403 - FORBIDDEN, RESOURCE NOT AVAILABLE FOR THIS API KEY




STATUS: 404 - THE SPECIFIED RESOURCE WAS NOT FOUND, EITHER ID IS WRONG OR OBJECT
CREATION PENDING




STATUS: 500 - UNSPECIFIED INTERNAL SERVER ERROR



--------------------------------------------------------------------------------

Suggestions, contact, support and error reporting;

Information URL:
https://www.txtgroup.com/about-us/offices-subsidiaries/pace-gmbh/
Contact Info: pace-support@txtgroup.com



All rights reserved
http://apache.org/licenses/LICENSE-2.0.html