Reporting API
API change history/operators/{operatorId}/flights - GET
/operators//flights - GET
Request
Request URL
Request headers
-
stringYour API Key
Request parameters
-
integer
Format - int32.
-
(optional)string
Format - api-filter.
-
(optional)boolean
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
Format - api-filter.
Request body
Not Applicable
Responses
200 OK
Success
Examples
{
"type": "object",
"properties": {
"totalItems": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int32"
},
"limit": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"nullable": true
}
},
"additionalProperties": false
}
{
"totalItems": 0,
"offset": 0,
"limit": 0,
"items": [
{}
]
}
{
"type": "object",
"properties": {
"totalItems": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int32"
},
"limit": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"nullable": true
}
},
"additionalProperties": false
}
{
"totalItems": 0,
"offset": 0,
"limit": 0,
"items": [
{}
]
}
{
"type": "object",
"properties": {
"totalItems": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int32"
},
"limit": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"nullable": true
}
},
"additionalProperties": false
}
401 Unauthorized
Unauthorized
Examples
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
403 Forbidden
Forbidden
Examples
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
404 Not Found
Not Found
Examples
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
429 Too many requests
Client Error
Examples
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
[
{
"code": 0,
"message": "string",
"overridable": true,
"category": 0,
"additionalData": {},
"dataField": "string",
"groupLabel": "string",
"universallyOverridable": true,
"techMessage": "string"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"overridable": {
"type": "boolean",
"nullable": true
},
"category": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"format": "int32"
},
"additionalData": {
"nullable": true
},
"dataField": {
"type": "string",
"nullable": true
},
"groupLabel": {
"type": "string",
"nullable": true
},
"universallyOverridable": {
"type": "boolean"
},
"techMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
Code samples
@ECHO OFF
curl -v -X GET "https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights?FlightDate={string}&ReturnAll={boolean}&offset={integer}&limit={integer}&LastUpdated={string}"
-H "x-subscription-key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("x-subscription-key", "{subscription key}");
// Request parameters
queryString["FlightDate"] = "{string}";
queryString["ReturnAll"] = "{boolean}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["LastUpdated"] = "{string}";
var uri = "https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights");
builder.setParameter("FlightDate", "{string}");
builder.setParameter("ReturnAll", "{boolean}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("LastUpdated", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("x-subscription-key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"FlightDate": "{string}",
"ReturnAll": "{boolean}",
"offset": "{integer}",
"limit": "{integer}",
"LastUpdated": "{string}",
};
$.ajax({
url: "https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("x-subscription-key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights";
NSArray* array = @[
// Request parameters
@"entities=true",
@"FlightDate={string}",
@"ReturnAll={boolean}",
@"offset={integer}",
@"limit={integer}",
@"LastUpdated={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"x-subscription-key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights');
$url = $request->getUrl();
$headers = array(
// Request headers
'x-subscription-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'FlightDate' => '{string}',
'ReturnAll' => '{boolean}',
'offset' => '{integer}',
'limit' => '{integer}',
'LastUpdated' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'x-subscription-key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'FlightDate': '{string}',
'ReturnAll': '{boolean}',
'offset': '{integer}',
'limit': '{integer}',
'LastUpdated': '{string}',
})
try:
conn = httplib.HTTPSConnection('usc-api.flightschedulepro.com')
conn.request("GET", "/reports/v1.0/operators/{operatorId}/flights?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'x-subscription-key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'FlightDate': '{string}',
'ReturnAll': '{boolean}',
'offset': '{integer}',
'limit': '{integer}',
'LastUpdated': '{string}',
})
try:
conn = http.client.HTTPSConnection('usc-api.flightschedulepro.com')
conn.request("GET", "/reports/v1.0/operators/{operatorId}/flights?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://usc-api.flightschedulepro.com/reports/v1.0/operators/{operatorId}/flights')
query = URI.encode_www_form({
# Request parameters
'FlightDate' => '{string}',
'ReturnAll' => '{boolean}',
'offset' => '{integer}',
'limit' => '{integer}',
'LastUpdated' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['x-subscription-key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body