The CAPA API aims to be a comprehensive REST interface allowing the programmatic retrieval of all the content that we have available (subject to licensing agreements). It is available as a premium addon to your existing CAPA Membership.
Gets an access token for the user.
IMPORTANT: Note that this is a description of the POST method for /account/token which may not be what you're looking for. If you want to know the basics of obtaining an access token, see the OAuth documentation.
Content-Type required | string Value: "application/json" You must send a Content-Type header. You'll receive (misleading) errors otherwise. |
username | string User's username. Required for a password grant. |
password | string User's password. Required for a password grant. |
grant_type required | string Enum: "password" "refresh_token" "authorization_code" Type of grant. IMPORTANT: Note that third-party clients are unable to use the |
scope required | string Value: "user" Grant scope. |
client_id required | string ID of the application. |
client_secret required | string Secret key for the application. |
refresh_token | string If you're doing a token refresh grant, then you need to send through the refresh token that you already have. |
code | string If you are logging in via an authorization code, put it here. |
redirect_uri | string If doing an authorization code grant, this parameter needs to be sent and it needs to match the redirect_uri that was in the original authorization query string. |
access_token required | string The access token for the user. |
refresh_token required | string The user's refresh token. |
expires_in required | integer Number of seconds until the access token expires. |
token_type required | string Value: "Bearer" The type of token returned. |
{- "username": "string",
- "password": "string",
- "grant_type": "password",
- "scope": "user",
- "client_id": "string",
- "client_secret": "string",
- "refresh_token": "string",
- "code": "string",
- "redirect_uri": "string"
}
{- "access_token": "string",
- "refresh_token": "string",
- "expires_in": 0,
- "token_type": "Bearer"
}
This will obtain an authorization code for use in an authorization code grant. Normally you don't want to access this, instead follow the information on obtaining an access token for the proper login flow.
client_id required | string The application ID. |
response_type required | string Value: "code" The response type required. This will always be "code". |
redirect_uri required | string The URL to redirect to upon a successful authorization. |
scope required | string Value: "user" The scope. We only have one at the moment - "user". |
{- "errors": [
- {
- "message": "string",
- "status": 400
}
]
}
Creates a new user account.
If a valid access token is sent with this request, the account created will be a subaccount of the account that the access token belongs to.
username | string User's username. If omitted, the username will be set to the account's email address. |
password required | string >= 8 characters User's password. Password must be 8 characters or longer, and contain at least one uppercase character, one lowercase character, and one number. |
email required | string User's email address. |
name required | string User's name. |
phone required | string^[0-9\(\)\+\.\s]+ User's phone number. This is required for new accounts, but optional for subaccounts. |
fax | string User's fax number. |
company required | string User's company. This is required for new accounts, but optional for subaccounts. |
sector required | integer User's industry sector. This is a integer that represents the sector. A list of sectors and their IDs can be accessed at /site/sectors. This is required for new accounts, but optional for subaccounts. |
country required | integer User's country. This is an integer that represents the country. A list of countries and their IDs can be accessed at /site/countries. |
source | string Account creation source (used to track lead sources). |
trial | boolean If the account should be on a trial, this sets up a request for it. |
data required | integer The newly created account ID. |
{- "username": "string",
- "password": "stringst",
- "email": "string",
- "name": "string",
- "phone": "string",
- "fax": "string",
- "company": "string",
- "sector": 0,
- "country": 0,
- "source": "string",
- "trial": true
}
{- "data": 0
}
Creates a request by a user to be given an account with trial level access.
It does not create an actual account.
name required | string^.{2,}\s+.{2,} User's full name. It must consist of at least two words. |
email required | string User's email address. |
phone required | string^[0-9\(\)\+\.\s]+ User's phone number. This is required for new accounts, but optional for subaccounts. |
company required | string User's company. This is required for new accounts, but optional for subaccounts. |
sector required | integer User's industry sector. This is a integer that represents the sector. A list of sectors and their IDs can be accessed at /site/sectors. This is required for new accounts, but optional for subaccounts. |
country required | integer User's country. This is an integer that represents the country. A list of countries and their IDs can be accessed at /site/countries. |
source | string Account creation source (used to track lead sources). |
position | string The user's job title. |
data required | boolean If the trial account request has been successfully submitted, |
{- "name": "string",
- "email": "string",
- "phone": "string",
- "company": "string",
- "sector": 0,
- "country": 0,
- "source": "string",
- "position": "string"
}
{- "data": true
}
This returns the user's account details.
The account ID may be the user's own ID, or the ID of an account that the user has ownership over.
id required | integer The user's account ID. |
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "id": 0,
- "username": "string",
- "owner": {
- "id": 0,
- "name": "string",
- "email": "string"
}, - "manager": {
- "name": "string",
- "email": "string"
}, - "position": "string",
- "name": "string",
- "email": "string",
- "company": "string",
- "phone": "string",
- "fax": "string",
- "address": "string",
- "suburb": "string",
- "state": "string",
- "postcode": "string",
- "country": {
- "id": 0,
- "name": "string",
- "code": "string"
}, - "sector": {
- "id": 0,
- "name": "string"
}, - "created": 0,
- "bounced": true,
- "mailok": true
}
}
Updates the user's account details with the submitted information.
id required | integer The user's account ID. |
username required | string User's username. If omitted, the username will be set to the account's email address. | ||||
email required | string User's email address. | ||||
name required | string^.{2,}\s+.{2,} User's name. | ||||
position | string The user's job title. | ||||
phone required | string^[0-9\(\)\+\.\s]+ User's phone number. This is required for parent accounts, but optional for subaccounts. | ||||
fax | string^[0-9\(\)\+\.\s]+ User's fax number. | ||||
company required | string User's company. This is required for parent accounts, but optional for subaccounts. | ||||
sector required | integer User's industry sector. This is a integer that represents the sector. A list of sectors and their IDs can be accessed at /site/sectors. This is required for parent accounts, but optional for subaccounts. | ||||
country required | integer User's country. This is an integer that represents the country. A list of countries and their IDs can be accessed at /site/countries. | ||||
state | string User's address state. | ||||
suburb | string User's suburb. | ||||
postcode | string User's postcode. | ||||
address | string User's address details excluding those in above parameters (e.g. street name, building number floor level, etc). | ||||
owner | integer Owner account's ID. | ||||
object The details of the account manager assigned to the account. | |||||
|
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "username": "string",
- "email": "string",
- "name": "string",
- "position": "string",
- "phone": "string",
- "fax": "string",
- "company": "string",
- "sector": 0,
- "country": 0,
- "state": "string",
- "suburb": "string",
- "postcode": "string",
- "address": "string",
- "owner": 0,
- "manager": {
- "name": "string",
- "email": "string"
}
}
{- "data": {
- "id": 0,
- "username": "string",
- "owner": {
- "id": 0,
- "name": "string",
- "email": "string"
}, - "manager": {
- "name": "string",
- "email": "string"
}, - "position": "string",
- "name": "string",
- "email": "string",
- "company": "string",
- "phone": "string",
- "fax": "string",
- "address": "string",
- "suburb": "string",
- "state": "string",
- "postcode": "string",
- "country": {
- "id": 0,
- "name": "string",
- "code": "string"
}, - "sector": {
- "id": 0,
- "name": "string"
}, - "created": 0,
- "bounced": true,
- "mailok": true
}
}
This lists all subaccounts connected to this account.
id required | integer The user's account ID. |
data required | boolean True if the account was deleted. |
{- "data": true
}
This returns an object that contains objects that represent each active subscription a user has. The key of each object will be the ID of the product.
If a subscription object contains a key called "included" that is true (along with name and shortname), and "email" that may be true or false, that means that the product with that ID is an included subscription with their account - ie. AVAN and Airline Leader will always be included subscriptions, no matter the account type. If it is an actual subscription, then the object will contain far more detailed information, which is shown below.
Note that the output for this call is pretty messy and unstable; it will eventually be changed to something a bit more ordered.
id required | integer The user's account ID. |
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "{prodID}": {
- "subid": 0,
- "start": 0,
- "trial": true,
- "expiry": 0,
- "users": 0,
- "owner": 0,
- "info": {
- "id": 0,
- "cid": 0,
- "username": "string",
- "company": "string",
- "name": "string",
- "orderid": 0,
- "trial": true,
- "prodid": 0,
- "start": 0,
- "expiry": 0,
- "active": true,
- "users": 0,
- "prodname": "string",
- "shortname": "string",
- "itemname": "string"
}, - "email": true,
- "included": true,
- "shortname": "string",
- "name": "string",
- "requires": 0
}
}
}
Change a user's password. :!: If you are a master account wanting to
change a subaccount's password, the OAuth authorisation header needs to
be sent, and the oldPassword
value needs to be set to the master
account's password.
id required | integer The user's account ID. |
oldPassword required | string The user's current password. If a master account is editing the subaccount's password, this should be the password of the master account. |
newPassword required | string The new password. |
token | string If the User has forgot the old password and is requesting the password, access requires a reset token acquired via the |
required | object | ||
|
{- "oldPassword": "string",
- "newPassword": "string",
- "token": "string"
}
{- "data": {
- "changed": true
}
}
This changes the user's subscription email preferences. Note that this is separate to Alerts.
id required | integer The user's account ID. |
id required | integer Product ID. |
subscribe required | boolean Whether to receive email for this product or not. |
required | object | ||
|
[- {
- "id": 0,
- "subscribe": true
}
]
{- "data": {
- "updated": true
}
}
This returns all bought items that the user has associated with the account. This will be all non-subscription items, like reports.
id required | integer The user's account ID. |
required | Array of objects | ||||||||||||||||||||||||
Array
|
{- "data": [
- {
- "url": "string",
- "price": 0,
- "currency": {
- "id": 0,
- "symbol": "USD"
}, - "image": "string",
- "sub": [
- {
- "id": 0,
- "price": 0,
- "period": 0
}
]
}
]
}
This runs a test to see if the supplied email parameter has an associated account.
email required | string User's email address. |
data required | boolean If the email is associated with an account, |
{- "data": true
}
If the user has forgotten their password, posting here will generate a reset token they can use to reset it.
username required | string The user's username. |
data required | string A response string, indicating that a reset token was sent to the email address on file for the account. |
{- "username": "string"
}
{- "data": "string"
}
Making a DELETE request to this resource will unsubscribe the user from a mailout. It does not require authentication, and its intention is to be used for unsubscribe links in emails.
id required | integer The user's account ID. |
prodid required | integer Product ID. |
data required | boolean |
{- "data": true
}
id required | integer The user's account ID. |
required | Array of objects (Account) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "data": [
- {
- "id": 0,
- "username": "string",
- "owner": {
- "id": "string",
- "name": "string",
- "email": "string"
}, - "manager": {
- "name": "string",
- "email": "string"
}, - "position": "string",
- "name": "string",
- "email": "string",
- "company": "string",
- "phone": "string",
- "fax": "string",
- "address": "string",
- "suburb": "string",
- "state": "string",
- "postcode": "string",
- "country": {
- "id": 0,
- "name": "string",
- "code": "string"
}, - "sector": {
- "id": 0,
- "name": "string"
}, - "created": 0,
- "bounced": true,
- "mailok": true
}
]
}
To disable a subaccount by owner, you can't disable yourself
id required | integer The user's account ID. |
data required | boolean True if the account was disabled. |
{- "data": true
}
This lists all subaccount IDs connected to this account that have been assigned access to the indicated subscription.
id required | integer The user's account ID. |
sub required | integer Subscription ID. |
data required | Array of integers A list of subaccount IDs that the subscription is assigned to. |
{- "data": [
- 0
]
}
id required | integer The user's account ID. |
sub required | integer Subscription ID. |
ID of subaccount this subscription should be assigned to.
data required | boolean Value: true This will be true if succesfully updated. |
[- 0
]
{- "data": true
}
id required | integer The user's account ID. |
required | Array of objects (Client) A list of API clients. | ||||||||||||||||||||
Array
|
{- "data": [
- {
- "identifier": "string",
- "name": "string",
- "redirects": [
- "string"
], - "domains": [
- "string"
], - "grants": {
- "password": true,
- "authorization_code": true,
- "implicit": true,
- "refresh_token": true
}
}
]
}
This will create a new API client with all grants disabled. Enable grants using the updateClient method.
id required | integer The user's account ID. |
name required | string API client name. This is a screen-friendly readable name for the client. |
identifier required | string This should be a unique client identifier. Ideally you'd make it all lowercase ASCII, and it needs to be completely unique. |
data required | string If successfully created, then the response here will be the client secret. This is the only time you will see this, so when it is received, save it somewhere as it is required for all non-implicit grants. |
{- "name": "string",
- "identifier": "string"
}
{- "data": "string"
}
id required | integer The user's account ID. |
client required | string Client identifier. |
required | object (Client) | ||||||||||||||||||||
|
{- "data": {
- "identifier": "string",
- "name": "string",
- "redirects": [
- "string"
], - "domains": [
- "string"
], - "grants": {
- "password": true,
- "authorization_code": true,
- "implicit": true,
- "refresh_token": true
}
}
}
id required | integer The user's account ID. |
client required | string Client identifier. |
object Options for which grants are enabled. Note that password grants are always disabled for third-party clients. | |||||||
| |||||||
redirects | Array of strings URL that this client is allowed to redirect to. | ||||||
domains | Array of strings Domain this client is allowed to be accessed from. Note that the protocol should be included in this (ie. "https://"). |
data required | boolean Value: true True if successfully updated. |
{- "grants": {
- "implicit": true,
- "authorization_code": true,
- "refresh_token": true
}, - "redirects": [
- "string"
], - "domains": [
- "string"
]
}
{- "data": true
}
id required | integer The user's account ID. |
client required | string Client identifier. |
data required | boolean Value: true True if successfully deleted. |
{- "data": true
}
This identifies and returns the details of the client matching the given unique identifier string.
identifier required | string Client identifier. |
required | object | ||||||||||||||||||||
|
{- "data": {
- "identifier": "string",
- "name": "string",
- "redirects": [
- "string"
], - "domains": [
- "string"
], - "grants": {
- "password": "string",
- "authorization_code": true,
- "implicit": true,
- "refresh_token": true
}
}
}
Returns a list of the current active sessions for an API client.
id required | integer The user's account ID. |
client required | string Client identifier. |
required | Array of objects | ||||||||
Array
|
{- "data": [
- {
- "id": "string",
- "userid": 0,
- "date": 0,
- "expires": 0
}
]
}
id required | integer The user's account ID. |
client required | string Client identifier. |
session required | string Session identifier. |
data required | boolean True if session was successfully deleted. |
{- "data": true
}
id required | integer The user's account ID. |
date | string <datetime> Return any announcements newer than this date. Defaults to today. |
required | Array of objects | ||||
Array
|
{- "data": [
- {
- "date": "string",
- "announcement": "string"
}
]
}
Provides confirmation tht the user has seen the identified announcement.
id required | integer The user's account ID. |
id required | integer This is the id of the announcement the user has seen. |
date required | string <datetime> Date announcement was seen. |
boolean True is returned. |
{- "date": "string"
}
{- "": true
}
id required | integer The user's account ID. |
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "freq": {
- "freq": 0,
- "sendat": "string"
}, - "alerts": [
- {
- "id": 0,
- "name": "string",
- "uid": "string",
- "types": [
- 0
], - "search": [
- {
- "id": 0,
- "type": "ALL",
- "match": true,
- "conditions": {
- "tags": [
- "string"
], - "cats": [
- 0
], - "profiles": [
- {
- "id": 0,
- "type": 0,
- "name": "string"
}
]
}
}
]
}
]
}
}
This will batch update/replace a user's alerts. The order of the array sent to the server will dictate the sort order of the user's Alerts. If an Alert is not sent to the server, it will be deleted.
id required | integer The user's account ID. |
Array of objects (Alert) The user's new Alerts, ordered. If this key is not sent, no Alerts will be changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object If you want to change Alert frequency settings, send this key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "alerts": [
- {
- "id": 0,
- "name": "string",
- "uid": "string",
- "types": [
- 0
], - "search": [
- {
- "id": 0,
- "type": "ALL",
- "match": true,
- "conditions": {
- "tags": [
- "string"
], - "cats": [
- 0
], - "profiles": [
- {
- "id": 0,
- "type": 0,
- "name": "string"
}
]
}
}
]
}
], - "freq": {
- "freq": 0,
- "sendat": "string"
}
}
{- "errors": [
- {
- "message": "string",
- "status": 400
}
]
}
id required | integer The user's account ID. |
id | integer ID of the Alert. | |||||||||||||||||||||||||||||||||
name | string Name of the Alert. | |||||||||||||||||||||||||||||||||
uid | string Unique identifier for the Alert. Use when building RSS feed URLs. | |||||||||||||||||||||||||||||||||
types required | Array of integers An array of news types to include in results. News types are:
| |||||||||||||||||||||||||||||||||
required | Array of objects An array of condition groups to filter news by. | |||||||||||||||||||||||||||||||||
Array
|
required | object | ||||
|
{- "id": 0,
- "name": "string",
- "uid": "string",
- "types": [
- 0
], - "search": [
- {
- "id": 0,
- "type": "ALL",
- "match": true,
- "conditions": {
- "tags": [
- "string"
], - "cats": [
- 0
], - "profiles": [
- {
- "id": 0,
- "type": 0,
- "name": "string"
}
]
}
}
]
}
{- "data": {
- "id": 0,
- "uid": "string"
}
}
This will return a list of articles that match the specified alert, in reverse-chronological order.
id required | integer The user's account ID. |
alertid required | integer The user's Alert ID. |
num | integer Maximum number of results to return. |
page | integer Zero-based result page index. |
from | integer Don't show alerts older than this (UNIX) time. |
nolimit | integer Value: 1 By default, searches are restricted to stories from within the past 3 months, in order to keep response times fast. If you want to go back further, send this parameter. |
linked | boolean If true, this causes all names that match to CAPA profiles to be changed to HTML links to those profiles. |
required | Array of objects (AlertResult) | ||||||||||||||||||||||
Array
|
{- "data": [
- {
- "id": 0,
- "title": "string",
- "article": "string",
- "type": {
- "id": 0,
- "name": "string"
}, - "image": "string",
- "timestamp": "string",
- "url": "string",
- "tags": [
- "string"
]
}
]
}
This changes the search parameters of an Alert.
id required | integer The user's account ID. |
alertid required | integer The user's Alert ID. |
id | integer ID of the Alert. | |||||||||||||||||||||||||||||||||
name | string Name of the Alert. | |||||||||||||||||||||||||||||||||
uid | string Unique identifier for the Alert. Use when building RSS feed URLs. | |||||||||||||||||||||||||||||||||
types required | Array of integers An array of news types to include in results. News types are:
| |||||||||||||||||||||||||||||||||
required | Array of objects An array of condition groups to filter news by. | |||||||||||||||||||||||||||||||||
Array
|
data required | boolean |
{- "id": 0,
- "name": "string",
- "uid": "string",
- "types": [
- 0
], - "search": [
- {
- "id": 0,
- "type": "ALL",
- "match": true,
- "conditions": {
- "tags": [
- "string"
], - "cats": [
- 0
], - "profiles": [
- {
- "id": 0,
- "type": 0,
- "name": "string"
}
]
}
}
]
}
{- "data": true
}
This will batch copy the selected alerts from a user's account to all of the selected subaccounts. Note: this requires that the user account has associated subaccounts.
id required | integer The user's account ID. |
userids required | Array of integers An array that contains the ID(s) of one or more subaccounts to copy the selected alerts to. It must contain at least one account ID and each ID must be of an subaccount to the user account. |
alertids required | Array of integers An array that contains the ID(s) of one or more alerts to copy to the selected accounts. It must contain at least one alert ID. |
type required | string Enum: "add" "replace" This property defines how the function interacts with existing alerts in the selected accounts. The available options are 'add' and 'replace'. add: This adds the alerts to the selected accounts. If an account already has an alert with the same name as one of the ones being duplicated, the duplicate is not copied to that account. replace: Any existing alerts for the selected accounts are deleted before copying the new alerts over. |
data required | boolean True is returned. |
{- "userids": [
- 0
], - "alertids": [
- 0
], - "type": "add"
}
{- "data": true
}
If you need an idea of the kind of results that will be returned when building an Alert, that can be done here.
id | integer ID of the Alert. | |||||||||||||||||||||||||||||||||
name | string Name of the Alert. | |||||||||||||||||||||||||||||||||
uid | string Unique identifier for the Alert. Use when building RSS feed URLs. | |||||||||||||||||||||||||||||||||
types required | Array of integers An array of news types to include in results. News types are:
| |||||||||||||||||||||||||||||||||
required | Array of objects An array of condition groups to filter news by. | |||||||||||||||||||||||||||||||||
Array
|
required | object (AlertResult) A single Alert result will contain an article and all the content for it. | ||||||||||||||||||||||
|
{- "id": 0,
- "name": "string",
- "uid": "string",
- "types": [
- 0
], - "search": [
- {
- "id": 0,
- "type": "ALL",
- "match": true,
- "conditions": {
- "tags": [
- "string"
], - "cats": [
- 0
], - "profiles": [
- {
- "id": 0,
- "type": 0,
- "name": "string"
}
]
}
}
]
}
{- "data": {
- "id": 0,
- "title": "string",
- "article": "string",
- "type": {
- "id": 0,
- "name": "string"
}, - "image": "string",
- "timestamp": "string",
- "url": "string",
- "tags": [
- "string"
]
}
}
This returns a list of destinations, grouped by the amount of flights going to them each week. It's a pretty ugly function with output that makes no sense, and will be rewritten eventually.
type required | integer Profile type ID. |
id required | integer Profile ID. |
rtype | string Enum: "domestic" "international" If this is set to |
ftype required | string Enum: "passenger" "cargo" Flight type. |
week | string <date> ISO8601 date of the week start. Must be a Monday. |
required | Array of objects | ||||||
Array
|
{- "data": [
- {
- "id": 0,
- "data": 0,
- "routes": "string"
}
]
}
Returns a list of tabs that are able to be displayed within a profile. This is used on the CAPA website to determine which tabs to display on profile pages.
type required | integer Profile type ID. |
id required | integer Profile ID. |
required | Array of objects | ||||||||||||||||||||||||||||||||
Array
|
{- "data": [
- {
- "title": "string",
- "type": "string",
- "requires": [
- "string"
], - "group": true,
- "items": [
- "string"
], - "traffic": {
- "group": true
}, - "financial": {
- "items": [
- "string"
], - "group": true
}, - "fleet": true,
- "schedulesAnalysis": true,
- "cargoAnalysis": true,
- "people": true
}
]
}
This is used to figure out a profile ID based on profile URL components. Only really useful for the CAPA site itself.
shorturl required | string The shorturl string. Given a URL of |
type required | string The type string. Given a URL of |
required | object | ||||
|
{- "data": {
- "id": 0,
- "type": 0
}
}
term | string Profile name to search for. Any profiles containing this string will be returned. |
code | string Profile IATA/ICAO/country code. If this is supplied, "term" will be ignored and only profiles that exactly match the specified code will be returned. |
start | integer If this is sent, then the "term" search will only match profiles that start with the term string, instead of profiles that contain the term string. If this value is a "#" it will return all entries that start with a number. |
required | Array of objects (ProfileSearchResult) | ||||||||||||||||||||||||||||||
Array
|
{- "data": [
- {
- "rank": 0,
- "id": 0,
- "type": {
- "id": 0,
- "name": "string"
}, - "name": "string",
- "iata": "string",
- "icao": "string",
- "url": "string",
- "country": {
- "id": "string",
- "name": "string",
- "code": "string"
}
}
]
}
This returns basic profile details - a short description, IATA/ICAO codes, location, etc. There are a few fields common to all profiles, however the resulting object will vary greatly depending on the profile type.
IMPORTANT: Profile IDs do not change - they will remain the same throughout their lifetime. The exception is in the rare event of a merge, when duplicate profiles are combined together. This is an administrative thing unrelated to airline mergers and does not happen often.
type required | integer Profile type ID. |
id required | integer Profile ID. |
required | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "data": {
- "iata": "string",
- "icao": "string",
- "duplicate": true,
- "name": "string",
- "efrom": "2019-08-24",
- "eto": "2019-08-24",
- "current": true,
- "bizmodel": "string",
- "category": 0,
- "address": "string",
- "hub": {
- "id": 0,
- "type": "string",
- "name": "string",
- "url": "string"
}, - "website": "string",
- "bio": "string",
- "currency": "USD",
- "financial_year_end": 0,
- "traffic_year_end": 0,
- "startup": true,
- "startupdate": "string",
- "failedstartup": true,
- "grounded": true,
- "country": {
- "id": 0,
- "code": "string",
- "name": "string",
- "url": "string",
- "schengen": true
}, - "region": {
- "id": "string",
- "name": "string",
- "code": "string"
}, - "carriesfreight": true,
- "hidetraffic": true,
- "hidetrafficmulti": [
- "string"
], - "hidefinancial": true,
- "hidefinancialmulti": [
- "string"
], - "hidetourismmulti": [
- "string"
], - "hasschedules": true,
- "group": {
- "id": 0,
- "type": 0,
- "name": "string",
- "majority": true,
- "financial_year_end": 0,
- "traffic_year_end": 0,
- "currency": "string",
- "showTrafficYTD": true,
- "hidetraffic": true,
- "hidefinancial": true,
- "url": "string"
}, - "alliance": {
- "id": 0,
- "type": 0,
- "joined": 0,
- "status": "string",
- "name": "string",
- "url": "string"
}, - "ownership": "string",
- "status": "string",
- "network": {
- "domestic": true,
- "international": "string"
}, - "image": "string",
- "tags": [
- "string"
], - "trafficsource": "string",
- "city": {
- "id": 0,
- "name": "string",
- "code": "string",
- "state": "string",
- "others": [
- {
- "id": 0,
- "name": "string",
- "iata": "string",
- "icao": "string",
- "url": "string"
}
]
}, - "disabled": true,
- "ceased": true,
- "runways": [
- {
- "length": "string",
- "width": "string",
- "area": "string"
}
], - "classification": "primary",
- "code": "string",
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "metaregion": {
- "id": 0,
- "name": "string"
}, - "fullname": "string",
- "subsidiaries": [
- {
- "id": 0,
- "type": 0,
- "name": "string",
- "iata": "string",
- "icao": "string",
- "majority": "string",
- "url": "string"
}
], - "founded": 0,
- "sector": {
- "id": 0,
- "name": "string"
}, - "type": "string",
- "investment": 0,
- "owner": "string",
- "throughput": [
- 0
], - "facilitysize": "string",
- "cargovolume": "string",
- "terminal": {
- "width": 0,
- "length": 0,
- "area": 0
}, - "completion": "2019-08-24",
- "atcos": 0,
- "employees": 0,
- "accs": 0,
- "towers": 0,
- "members": "string",
- "url": "string",
- "parent": [
- {
- "id": 0,
- "type": 0,
- "name": "string",
- "url": "string",
- "iata": "string",
- "icao": "string",
- "financial_year_end": 0,
- "traffic_year_end": 0,
- "currency": "string"
}
], - "groundhandlers": [
- {
- "id": 0,
- "type": 0,
- "name": "string",
- "iata": "string",
- "icao": "string",
- "url": "string"
}
], - "fuelsuppliers": [
- {
- "id": 0,
- "type": 0,
- "name": "string",
- "url": "string"
}
], - "supplies": {
- "id": 0,
- "type": 0,
- "name": "string",
- "iata": "string",
- "icao": "string",
- "latitude": 0,
- "longitude": 0,
- "url": "string"
}, - "fuels": {
- "id": 0,
- "type": 0,
- "name": "string",
- "iata": "string",
- "icao": "string",
- "latitude": 0,
- "longitude": 0,
- "url": "string"
}
}
}
This returns a list of aircraft due for delivery for a profile.
type required | integer Profile type ID. |
id required | integer Profile ID. |
required | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "data": [
- {
- "model": {
- "id": 0,
- "name": "string",
- "freighter": true
}, - "deliveries": [
- {
- "airline": {
- "id": 0,
- "type": 0,
- "name": "string"
}, - "years": [
- {
- "year": 0,
- "order": {
- "aircraft": 0,
- "seats": 0,
- "cargo": 0
}, - "option": {
- "aircraft": 0,
- "seats": 0,
- "cargo": 0
}
}
]
}
]
}
]
}
This returns a summary of the aircraft in use by a profile for the current week.
type required | integer Profile type ID. |
id required | integer Profile ID. |
date | string <date> ISO8601 date that the aircraft have to be active on to be included in the list. If blank, it defaults to the current date. |
required | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|