Airport Data Objects
Airport Data
The Mappedin system has four types of object that can be synced that are specific to airports: Check-In Counter, Security Wait Times, Flight and Parking. These objects provide additional capabilities to Mappedin Web users, such as:
- Searching for their gate by flight number
- Integrating security wait times into estimated journey times
- Finding the check-in counter for their airline
- Viewing available parking
Check-In Counter
The airline occupying a specific set of check-in counters may vary over the course of a day. A check-in
is a special type of location that may only be active for a set period in the day. To handle this, Mappedin can run a higher frequency sync to an airline check-in
endpoint that returns current active check-ins to ensure counters are accurately associated with the correct airlines on the map at all times.
Property | Description | Type | Importance |
---|---|---|---|
name | Airline name | string | Required |
externalId | Unique identifier of the location entry | string | Required |
type | Differentiates check-in locations from regular locations. Use value check-in to specify a check-in location. | string | Required |
polygon | Unique identifier(s) of related check-in counter polygon(s) in the map | Array<string> | Required |
logo | URL to airline logo image | string | Required |
Click to view a JSON example.
[ { "name": "Airline Name", "externalId": "location_id_1", "type": "check-in" "polygons": ["check-in-counter-1A", "check-in-counter-1B", "check-in-counter-1C"], "logo": "http://www.example.com/Example-Airline-Logo.jpg", }]
Security Wait Times
On a Mappedin Map, a connection is used to represent a path between two nodes. Security checkpoints are represented as connections that allow passage in only one direction and have a wait time, representing the time it takes for a traveller to pass through it.
Property | Description | Type | Importance |
---|---|---|---|
externalId | Unique identifier of the connection | string | Required |
waitTime | Wait time in minutes for the given connection | number | Required |
Click to view a JSON example.
[ { "externalId": "SEC1", "waitTime": 5 }, { "externalId": "SEC2", "waitTime": 15 }, { "externalId": "SEC3", "waitTime": 9 },]
Flight
Flight data allows a user to perform a search using their airline name or flight code. The search results can show them additional details and provide directions to the gate of departure or arrival.
It is recommended to pass both the checkinId
and claimUnitId
where relevant on each flight. This allows the map to accurately route to the relevant check-in or baggage claim.
Property | Description | Type | Importance |
---|---|---|---|
id | Unique identifier | string | Required |
airlineCode | Airline code | string | Required |
airlineName | Airline name | string | Required |
airportName | Airport name | string | Required |
sectorName | Terminal name or number | string | Required |
primaryGate | Gate number | string | Required |
claimUnit | Baggage claim number | string | Required |
leg | Arrival or departure leg | A or D | Required |
flightStatus | Object containing status & color. Color can be set using CSS colors names DarkGoldenRod , as Hex strings #0000FF or the rgb values rgb(255,0,0) . | status: string , color: string | Required |
flightNumber | Flight number | string | Required |
scheduledTimeLocal | Scheduled time or arrival or departure in ISO 8601 format | string | Required |
estimatedTimeLocal | Estimated time of arrival or departure in ISO 8601 format | string | Optional |
checkinId | Unique identifier of the polygon representing the check-in counter | string | Optional |
claimUnitId | Unique identifier of the polygon representing the baggage claim | string | Optional |
Click to view a JSON example.
{ "id": "2024-AL-123", "airlineCode": "AL", "airlineName": "Airline", "airportName": "Airport", "sectorName": "Domestic", "primaryGate": "50", "claimUnit": "8" "leg": "A", "flightStatus": { "status": "DEPARTED", "color": "#2266FF" }, "flightNumber": "AL123", "scheduledTimeLocal": "2024-04-03T09:00:00.000", "estimatedTimeLocal": "2024-04-03T09:15:00.000", "checkinId": "POLY-123", "claimUnitId": "POLY-456" }
Parking
Using the parking object allows users to see information about parking lots. They can check for things such as the parking lot size, number of free spaces and whether the parking lot is open or closed.
Property | Description | Type | Importance |
---|---|---|---|
id | Unique identifier | string | Required |
name | Parking lot name | string | Required |
externalId | Unique identifier of the location for the parking lot entrance | string | Optional |
freeSpaces | Number of free parking spaces | number | Required |
totalSpaces | Total number of parking spaces | number | Required |
freeEVSpaces | Free electric vehicle charging spaces | number | Optional |
status | Status of the parking lot | string | Required |
color | Color for the status pill and parking lot background. Color can be set using CSS colors names DarkGoldenRod , as Hex strings #0000FF or the rgb values rgb(255,0,0) . | string | Required |
lastUpdatedDate | Last updated time in local time in ISO 8601 format | string | Required |
isClosed | Whether the parking lot is closed | boolean | Optional |
Click to view a JSON example.
{ "id": "PA", "name": "Parking A", "externalId": "POLY-123", "freeSpaces": 200, "totalSpaces": 300, "freeEVSpaces": 10, "status": "OPEN", "color": "#33AC30", "lastUpdatedDate": "2024-04-03T13:36:07.983" "isClosed": false,}