FlightFollower

The FlightFollower API returns the map image for the flight specified.

Format

Verb Request
GET https://host:port/flightfollower/v1/{departure}/{arrival}/{airline}/{flight number}?imgWidth=99&imgLength=99&[imgType=gif]&[rfc2397=true/false]&[base64=true/false]]

Path Parameters

Key Description Required
departure The airport IATA code for departure. Yes
arrival The airport IATA code for arrival. Yes
airline The IATA airline (two digits) code Yes
flightnumber The flight number. For example, ZZ0650 Yes

Request Query Parameters

Key Description Required
imgWidth Number of pixels; must be integer; minimum 50; maximum 1024. Total pixels (imgWidth x imgLength) may not exceed 745,472*. Yes
imgLength Number of pixels; must be integer; minimum 50; maximum 1024. Total pixels (imgWidth x imglength) may not exceed 745,472*. Yes
imgType File format. Currently the only value accepted is ‘gif’. (Default gif) No
base64 Return the map image translated in ASCII format. (Default true) No
rfc2397 Return the image with the Data URI scheme. (Default false) No
callback name of callback function - (JSONP) No

Payload Examples

Request

http://host:port/flightfollower/v1/GRU/MIA/UA/1?imgWidth=300&imgLength=300&base64=false

Response

Request

http://host:port/flightfollower/v1/GRU/MIA/UA/1?imgWidth=50&imgLength=50&imgType=gif

Response

R0lGODdhMgAyAOcAACMjdXDbkwAAAAAA/59fn6UqKl+fn/9/AEJCbwD//y9PL09PL5kyzGsjji9PTwCAgFRUVI4jIwBmAMx/MtvbcMDAwAD/AJPbcE8vL5+fX7Di/+Hh4XyY0wCvFP8A/48AUgCTjzIyzDKBS9HBZr1SvTR3ZmpqjSOOIwDS0tUgeS8vZP+HAP9FAO+E73PeeP+1xcVIm/8AAOmWevSkYFKVhJZSLXKf/36Iq0GsQVRwqt64h9i/2BnM35w+zvM+lvXes///////ADLYOADw8ACQkIDgUGS4QEiQMCxoIBBAEPDAEPCAIPAQIJAAALAggMpAoOVgwP+A4JHwAA+LAP/1APKuAP8AoA8PDxwcHDExMUVFRVpaWm9vb4SEhJiYmK2trcLCwtfX1+vr6/r6+v//8EcgFoBjIEVFmgBRAJlmM8yZZpmZZgAAdzMzAMzMmWZ+mYifiMwzALqliIWr0qiOb4pyVPLr2sjV5YWPpoQgHgE6aSxNjUBaguXs8kB3oLa7yfNvHEqbaUKIaVR6N12FRFxnP2VyTCF3NCpwGy51IsynP9WyTM2eN7usabq1cUp1cWWOSVvBhVSceryNd9apRM1+RWSYRNaKUm6ZVW2zU25vI2V2PClkPKXASpqbNKOlPSqBPeCGKeB2MKN0Kd6zJ9+LLZ6ROKqZLq+XGaxyLIySJqaTJ6eKH6OUG12JNKKdI9+qHzJdI5mkPKueJJS117LK4uDq88LV6O/0+dHf7qPA3b2qk+3o4cu7pfTw7ci4pdPGtPbz8OXd0t7Uyeni2+fw7Ojt7Y3AobvZxnGljuny7sfdzICAgAEBAcrd8oiy4pq+5/T4/L/W8Hio3t3p99Li9G2h3P+6h/j6/bDM7Ja85uXu+P+bUmqe22me22Wc2sfb8qXF6uHs+P/6+P/QrP+XTP97G//p2rzU73Wm3k+O1UyM1FqV2Iu048fa8sPY8I+25Nbk9Yey4vv8/v/WuP/Lpf+kYv/49KzK6zF6zhBlxjl/0LjR7nyq4Nrn9i54zSwAAAAAMgAyAAAI/gDpCFQUSpSoUQIFDiJFqlQpU40aOZpDsaLFixgzzknIUU4mSJAqiESVKpWqQ4c0zhHEUqVKOXLoxBQIUySQmyIlPhJU8eYtireAFBN082ZFXTdrWfQJkyOkVxVw2gRSgWdFokBwUcQFxNgjpEB0Vcx109bSrDEHqaWDKGoFZs3iMnNLkSVWIMdq3fQ6h6tFXICB0Op5M2ZLilHhxpVL9WJWW4CRdX3UF8hRILeCKqX4uM5Ft4tD0+2JSy+QZECUbbVMkWwtpGY5l6bzmSqQ0EUb182aW2huzr0Fy95Y++bi281Gy2Y9hzdYy6Z16SL7s7lW2s1ZFz3ejJnRpX6X/v+29R2pVuvEswuMCkRxe/bYz35nTt+lQIo06bAXyf5mwqWPPHIIT/Vx5tJMHNFmm1R0AJGggnN00slEBTZnHyGD3DSIIopYyJ9ARsXHmSCefNKIhQamqBEdijByUyGK9JaddhjJ+FtPLlHkCIeFJDRIITvVmOOQKtk1yECLAElYcEw26WRRjkTUiFWCFAKjI3c9qeWWQEwySUReTuIII2RyaeaWXkoZEUsunulmk4IEGOYkdr1pZ28ROfJImCwxec2dZkYSSZRSOuIIk9wAyuVFhj7S2zjklGPOOU2ik44666zDTjvuuHlRJH3mNg499dhTzj294ZOPPqy2yuo+/vw02U83tNJqUXzBjWMPOeegelM037jKjjbhhKONOqy2w+Q/+vzj7D+3YpcrPeTkhg07rU7DVW/UIDtNcMzeWGOuvQWrTz7vkEHGDz+Qkds82GbTW7hFacQkpUXBw+o/25zzQz0/nEPBTffUcw82++wzrz7vNPyOvcGR4ys1rXYKMAXnkDEwEJLSAwQ/+lCTG7OuQtwbPX8C0Q+r+NxEAQXsCgxEPeZMetM+74zMsMMm53aOOagiq+xNPyjxMsY/1zzOTe3kXBS9340bXDn2AFGN00UVDXMwS9ScstVYAwE1c44xSY85X5vdtTlL+ArEPP7oLG7ZTNpjjj1uFxXM7TU114yvrN3MTfejdt9dz+HXcNM323+bqdKT9Ei6+OLX5O04esNpec419nRuzzX0LH3ncJkraudgWZEGnOlnKpU66ay7adbrmM8Xu5a0fJf7eVHPQd4uAu0CxDA0zQRaaHEp19MtZNlyC3nV+ZSZdED4AswvvgDRC4IxHY+88sPlwhUu1c3o0xy6EHMTL9vDNFP37SHvXQVEEpmQ++5z5JZi3YFff0Z0GAQh8Jc/muxnKvT730Xsgh8rDZCAMFLEIrrXH5EokCKBsAtKBjSHQSACEYkI4QMT8cEPJkItguCPVS6okv9gBDsurF9AAAA7

Request

http://host:port/flightfollower/v1/GRU/MIA/UA/1?imgWidth=300&imgLength=300&imgType=gif&rfc2397=true

Response

data:image/gif;base64,R0lGODdhLAEsAecAACMjdXDbkwAAAAAA/59fn6UqKl+fn/9/AEJCbwD//y9PL09PL5kyzGsjji9PTwCAgFRUVI4jIwBmAMx/Mt...

Errors

HTTP Code Reason Payload
400 Auth Failed

{
 "errors":
   {"error":[
     {"description":"authentication failed",
       "code":"9998"
     }
   ]
  },
  "success":false
}
400 Invalid Width

{
  "errors": {
     "error": [
        {
          "description": "Invalid minimum pixel width",
          "code": "5001"
        }
     ]
    },
    "success": false
}
400 Invalid Width

{
  "errors": {
     "error": [
        {
          "description": "Invalid maximum pixel width",
          "code": "5002"
        }
     ]
    },
    "success": false
}
400 Invalid Height

{
  "errors": {
     "error": [
        {
          "description": "Invalid minimum pixel length",
          "code": "5003"
        }
     ]
    },
    "success": false
}
400 Invalid Height

{
  "errors": {
     "error": [
        {
          "description": "Invalid minimum pixel length",
          "code": "5004"
        }
     ]
    },
    "success": false
}
400 Invalid Airport

{
  "errors": {
     "error": [
        {
          "description": "Invalid departure airport",
          "code": "5005"
        }
     ]
    },
    "success": false
}
400 Invalid Airport

{
  "errors": {
     "error": [
        {
          "description": "Invalid arrival airport",
          "code": "5006"
        }
     ]
    },
    "success": false
}
400 Invalid Airline

{
  "errors": {
     "error": [
        {
          "description": "Invalid airline",
          "code": "5007"
        }
     ]
    },
    "success": false
}
400 Invalid Image Type

{
  "errors": {
     "error": [
        {
          "description": "Invalid image type. Supported format is 'gif'.",
          "code": "5008"
        }
     ]
    },
    "success": false
}
404 No Service Available

{
  "errors": {
     "error": [
       {
         "description": "no service available",
         "code": "1003"
       }
      ]
   },
   "success": false
}

503 System Error

{{
  "errors": {
     "error": [
       {
         "The service was unable to recover the flightfollower for {airline}",
         "code": "1006"
       }
      ]
   },
   "success": false
}