RESTv1 Schedules API

Owned by Nick Naves
Last updated: May 02, 2017 by Kristian Luck
72 min read

This article is meant for developers who are actively developing (or plan to develop) against our RESTful APIs, and wish to integrate Scheduling.

Boomerang will be used to demonstrate some requests.

This document assumes the following:

  • You are familiar with using APIs that implement RESTful architecture.
  • You have proper credentials and are using them with each request using the authorization header.
  • You having working knowledge of schedules in our ameliaRES application.

Throughout this document:

  • 'schedules API' refers to your company's RESTful base API URL plus the schedules identifier - ex: https://InteliSys-api.intelisys.ca/RESTv1/schedules
  • 'href' refers to the Schedules API endpoint plus the addition of the unique key identifying a schedule - ex: https://InteliSys-api.intelisys.ca/RESTv1/schedules/1bCnbORHEDe61ZQPMeZvF3NeMFhgFkqcMmgZmWebpys=
Contents

Search (GET)

A search request to schedules consists of a date range provided via the URL parameters earliestDate and latestDate. You may additionally narrow the scope of the response with any number of additional parameters listed below.

 

URL Parameter

Type

Required

earliestDate

UTC Date (ex. 2016-01-01)

Yes

latestDate

UTC Date (ex. 2017-01-01)

Yes

departureAirport

Airport Code (ex. YUL)

No

arrivalAirport

Airport Code (ex. YUL)

No

arcraftModel

Aircraft Model Key

No

flightType

FlightType code (ex. ‘S’)

No

airlineCode

Airline Code (ex. ‘VJ’)

No


Sample Request URL

Below is a sample request using all possible URL parameters.

https://intelisys-api.intelisys.ca/RESTv1/schedules?earliestDate=2016-11-04&latestDate=2017-01-01&departureAirport=YQM&arrivalAirport=YHZ&airlineCode=YY&flightType=S&aircraftModel=2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=

Sample Response

[
    {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/1bCnbORHEDe61ZQPMeZvF3NeMFhgFkqcMmgZmWebpys=",
        "key": "1bCnbORHEDe61ZQPMeZvF3NeMFhgFkqcMmgZmWebpys=",
        "airlineCode": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
            "code": "YY",
            "name": "Intelisys Air"
        },
        "flightNumber": "256",
        "status": {
            "active": true,
            "cancelled": false
        },
        "validFrom": "2016-01-01 00:00:00Z",
        "validTo": "2016-12-31 00:00:00Z",
        "frequency": {
            "sunday": false,
            "monday": true,
            "tuesday": true,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": false
        },
        "aircraftModel": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
            "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
            "identifier": "CRJ7",
            "name": "Canadair  CRA"
        },
        "flightType": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
            "code": "S",
            "name": "Scheduled"
        },
        "flightCount": 260,
        "departure": {
            "airport": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YQM",
                "code": "YQM",
                "name": "Moncton"
            }
        },
        "arrival": {
            "airport": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YHZ",
                "code": "YHZ",
                "name": "Halifax International"
            }
        },
        "legs": [
            {
                "key": "1USCElijHYb0avSoDwoYEkqE7dxIPqr0UNIPuƒsh7yk=",
                "legNumber": 1,
                "legStatus": {
                    "active": true,
                    "cancelled": false
                },
                "distance": {
                    "length": 164.46,
                    "unitOfMeasurement": "km"
                },
                "departure": {
                    "utcScheduledShortTime": "08:00",
                    "airport": {
                        "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YQM",
                        "code": "YQM",
                        "name": "Moncton",
                        "utcOffset": {
                            "iso": "-04:00",
                            "hours": -4,
                            "minutes": -240
                        }
                    }
                },
                "arrival": {
                    "utcScheduledShortTime": "09:00",
                    "airport": {
                        "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YHZ",
                        "code": "YHZ",
                        "name": "Halifax International",
                        "utcOffset": {
                            "iso": "-04:00",
                            "hours": -4,
                            "minutes": -240
                        }
                    }
                },
                "timestamp": "AAAAAAAY7gI="
            }
        ],
        "timestamp": "AAAAAAAYyuE="
    },
    {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/GUxFvMq7boEIAmI8IjwkAxqdyB0BtPuuF%C6%92F9HKE3N48=",
        "key": "GUxFvMq7boEIAmI8IjwkAxqdyB0BtPuuFƒF9HKE3N48=",
        "airlineCode": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
            "code": "YY",
            "name": "Intelisys Air"
        },
        "flightNumber": "299",
        "status": {
            "active": true,
            "cancelled": false
        },
        "validFrom": "2016-03-01 00:00:00Z",
        "validTo": "2016-12-31 00:00:00Z",
        "frequency": {
            "sunday": true,
            "monday": true,
            "tuesday": true,
            "wednesday": true,
            "thursday": true,
            "friday": true,
            "saturday": true
        },
        "aircraftModel": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
            "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
            "identifier": "CRJ7",
            "name": "Canadair  CRA"
        },
        "flightType": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
            "code": "S",
            "name": "Scheduled"
        },
        "flightCount": 306,
        "departure": {
            "airport": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YQM",
                "code": "YQM",
                "name": "Moncton"
            }
        },
        "arrival": {
            "airport": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YHZ",
                "code": "YHZ",
                "name": "Halifax International"
            }
        },
        "legs": [
            {
                "key": "1USCElijHYb0avSoDwoYEouFXUjehjFOOIv5ASNinƒU=",
                "legNumber": 1,
                "legStatus": {
                    "active": true,
                    "cancelled": false
                },
                "distance": {
                    "length": 164.46,
                    "unitOfMeasurement": "km"
                },
                "departure": {
                    "utcScheduledShortTime": "09:00",
                    "airport": {
                        "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YQM",
                        "code": "YQM",
                        "name": "Moncton",
                        "utcOffset": {
                            "iso": "-04:00",
                            "hours": -4,
                            "minutes": -240
                        }
                    }
                },
                "arrival": {
                    "utcScheduledShortTime": "09:45",
                    "airport": {
                        "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YHZ",
                        "code": "YHZ",
                        "name": "Halifax International",
                        "utcOffset": {
                            "iso": "-04:00",
                            "hours": -4,
                            "minutes": -240
                        }
                    }
                },
                "timestamp": "AAAAAAAY7lQ="
            }
        ],
        "timestamp": "AAAAAAAYyxE="
    }
]

Individual (GET)

You can retrieve an individual schedule using its 'href' - provided in each schedule returned during a search.

Below is the URL for a GET request for a schedule.
https://intelisys-api.intelisys.ca/RESTv1/schedules/1bCnbORHEDe61ZQPMeZvF3NeMFhgFkqcMmgZmWebpys=


Sample Response

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/1bCnbORHEDe61ZQPMeZvF3NeMFhgFkqcMmgZmWebpys=",
    "key": "1bCnbORHEDe61ZQPMeZvF3NeMFhgFkqcMmgZmWebpys=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "256",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-01-01 00:00:00Z",
    "validTo": "2016-12-31 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": true,
        "wednesday": true,
        "thursday": true,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 260,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YQM",
            "code": "YQM",
            "name": "Moncton"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YHZ",
            "code": "YHZ",
            "name": "Halifax International"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEkqE7dxIPqr0UNIPuƒsh7yk=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 164.46,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "08:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YQM",
                    "code": "YQM",
                    "name": "Moncton",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YHZ",
                    "code": "YHZ",
                    "name": "Halifax International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAY7gI="
        }
    ],
    "timestamp": "AAAAAAAYyuE="
}

Creating a schedule (POST)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.

To create a schedule, you can perform a POST operation to the schedules API providing the schedule in the request body.

Sample Request Body

{
  "airlineCode": {
    "code": "YY"
  },
  "flightNumber": "9999",
  "validFrom": "2016-10-27 00:00:00Z",
  "validTo": "2017-10-24 23:59:59Z",
  "frequency": {
    "sunday": true,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true
  },
  "aircraftModel": {
    "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4="
  },
  "flightType": {
    "code": "S"
  },
  "legs": [
    {
      "departure": {
        "utcScheduledShortTime": "04:00",
        "airport": {
          "code": "DCA"
        }
      },
      "arrival": {
        "utcScheduledShortTime": "08:00",
        "airport": {
          "code": "YYZ"
        }
      }
    }
  ]
}

Sample Response

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6LsrsBFuc3O7ccwHOTpx3UI=",
    "key": "mh5xrw8N4GrFKuVsbKMF6LsrsBFuc3O7ccwHOTpx3UI=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9999",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": true,
        "monday": true,
        "tuesday": true,
        "wednesday": true,
        "thursday": true,
        "friday": true,
        "saturday": true
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEtIEIJcFuKEbMWiUrbIquWY=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "08:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZZWg="
        }
    ],
    "timestamp": "AAAAAAAZZWY="
}

Updating a schedule (PUT)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.
  • This will modify any flights created from the schedule.


Steps to update a schedule:

1. Perform a GET operation for the individual schedule you wish to update using the href.

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9999",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": true,
        "monday": true,
        "tuesday": true,
        "wednesday": true,
        "thursday": true,
        "friday": true,
        "saturday": true
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "08:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZdAc="
        }
    ],
    "timestamp": "AAAAAAAZdAU="
}

2. Make the required modifications to the schedule body.

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {							<-- Modified the frequency from all week to Monday, Wednesday and Friday.
        "sunday": false,   
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",   <-- Modified the arrival time to 9:00 from 8:00
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZdAc="
        }
    ],
    "timestamp": "AAAAAAAZdAU="
}

3. Perform a PUT operation to the associated 'href' of the schedule with the modifications in the payload body.

4. A successful completion will return a 200 OK status code and the modified schedule in the response body.

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZdA0="
        }
    ],
    "timestamp": "AAAAAAAZdAo="
}

Disable / enable a schedule (PUT)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.
  • This will disable any flights created from the schedule.

Disabling a schedule is done through the PUT operation using the 'status' property.

Steps to disable a schedule:

  1. Perform a GET operation for the individual schedule you wish to update using the href.

  2. Modify the schedule's status property by setting the cancelled property to true and the active property to false.

    {
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {                        <----- Modified by setting 
        "active": false,               <----- active to false
        "cancelled": true              <----- cancelled to true
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 156,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZdA0="
        }
    ],
    "timestamp": "AAAAAAAZdAo="
}
  3. Perform a PUT operation to the associated 'href' of the schedule with the modifications in the payload body.

  4. A successful completion will return a 200 OK status code and the modified schedule in the response body.

    {
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {
        "active": false,
        "cancelled": true         <-------------------------------------------------------- DISABLED
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 156,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": false,
                "cancelled": true      <-------------------------------------------------------- DISABLED
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZeFo="
        }
    ],
    "timestamp": "AAAAAAAZdoI="
}
  5. You will see the schedule is now disabled along with each schedule leg.

Remove a schedule (DELETE)

  • You must have the 'Flight Scheduling Flight And Route Delete' permission to perform this operation.
  • This will delete any flights created from the schedule.

To delete a schedule, simply perform a DELETE operation to the href of the schedule.

A successful response will return a 200 OK status code.

Building the flight schedule (POST)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.
  • This operation is non-atomic, meaning it will not fail due to errors encountered.

To create the flight schedule, POST to the href of the schedule and add the '/buildFlights' action.

https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=/buildFlights

The API will respond with a list of errors encountered during the operation. 

Each error consists of basic information of the flight that failed and a reason for the failure.

[
    {
        "flight": {
            "airlineCode": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
                "code": "YY"
            },
            "flightNumber": "9988",
            "departure": {
                "scheduledTime": "2016-10-28 00:00:00Z"
            }
        },
        "reason": "FLIGHTEXISTS"
    },
    {
        "flight": {
            "airlineCode": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
                "code": "YY"
            },
            "flightNumber": "9988",
            "departure": {
                "scheduledTime": "2016-10-31 00:00:00Z"
            }
        },
        "reason": "FLIGHTEXISTS"
    },
    {
        "flight": {
            "airlineCode": {
                "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
                "code": "YY"
            },
            "flightNumber": "9988",
            "departure": {
                "scheduledTime": "2016-11-02 00:00:00Z"
            }
        },
        "reason": "FLIGHTEXISTS"
    }
]

Rolling - Copying an existing schedule (POST)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.

This operation will create a new schedule using the existing schedule as the template.

Two URL parameters ('from', 'to') are required - these are the date range for the new schedule.

URL Parameter

Type

Required

Default

from

UTC Date (ex. 2016-01-01)

Yes

 

to

UTC Date (ex. 2017-01-01)

Yes

 

overWriteExistingSchedules

Boolean

No

False

To perform this operation, construct the POST URL with the following components:

  1. The href of the existing schedule you wish to copy.
  2. The  "/rollSchedule" action.
  3. The required URL parameters.

An example request URL is shown below.

https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=/rollSchedule?from=2017-10-27&to=2018-10-25

A successful response will consist of a 201 CREATED status code with the created schedule in the response body.

Splitting a schedule by date (PUT)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.

This operation will split the schedule into two separate schedules using the provided URL parameter ('splitDate') as the point to split.

URL Parameter

Type

Required

splitDate

UTC Date (ex. 2016-01-01)

Yes

We will walk through splitting an existing schedule by date with examples below.

The existing schedule we want to modify looks like this:

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {
        "active": false,
        "cancelled": true
    },
    "validFrom": "2016-10-27 00:00:00Z",    
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 156,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZdA0="
        }
    ],
    "timestamp": "AAAAAAAZdAo="
}

The schedule is valid from 2016-10-27 to 2017-10-25 and we want to split the schedule on 2017-04-12.

To perform this operation, construct the POST URL with the following components and send the request.

  1. The href of the existing schedule you wish to split.
  2. The  "/splitSchedule" action.
  3. The required URL parameters.

An example request URL is shown below.

https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=/splitSchedule?splitDate=2017-04-12

A successful response will consist of a 201 CREATED status code with the created schedule in the response body.

The created schedule is valid for the latter date portion 2017-04-12 (the 'splitDate') to 2017-10-25 (the end of the original schedule).

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6GgUESh37WSXMx2PjyfDTH8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6GgUESh37WSXMx2PjyfDTH8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {
        "active": false,
        "cancelled": true
    },
    "validFrom": "2017-04-12 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 85,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEoIQUCVx0osƒHytEEGEGIzU=",
            "legNumber": 1,
            "legStatus": {
                "active": false,
                "cancelled": true
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZejc="
        }
    ],
    "timestamp": "AAAAAAAZejQ="
}

The original schedule that we split will now be valid from 2016-10-27 to 2017-04-11 (one day before our 'splitDate').

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6CdZzoB0nzPPAp63em4NEw8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9988",
    "status": {
        "active": false,
        "cancelled": true
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-04-11 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 71,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEg2¥8kO¥JLxdcqƒMm1G5bLI=",
            "legNumber": 1,
            "legStatus": {
                "active": false,
                "cancelled": true
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "09:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZeFo="
        }
    ],
    "timestamp": "AAAAAAAZejI="
}

Splitting a schedule by frequency (PUT)

  • You must have the 'Flight Scheduling Route Modify' permission to perform this operation.

This operation will split the schedule into two separate schedules using the provided weekly frequency.

We will walk through splitting an existing schedule by frequency using examples.

The existing schedule we want to modify looks like this:

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6J0JS8%C6%92dhVKf%C2%A5QlVqb9NwRI=",
    "key": "mh5xrw8N4GrFKuVsbKMF6J0JS8ƒdhVKf¥QlVqb9NwRI=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9999",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": true,
        "monday": true,
        "tuesday": true,
        "wednesday": true,
        "thursday": true,
        "friday": true,
        "saturday": true
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEoEAfN3ScJvXKvc0LiGtJvY=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "08:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZf1E="
        }
    ],
    "timestamp": "AAAAAAAZf08="
}

All weekdays are selected in this schedule's frequency.

We will now split the schedule by Sunday, Tuesday, Thursday, and Saturday.

First, we construct a request to the href of the existing schedule with the addition of the action '/splitSchedule' - for example:

https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6J0JS8%C6%92dhVKf%C2%A5QlVqb9NwRI=/splitSchedule

We add our split frequency in the request body and send the request.

A successful completion will return a 201 CREATED status code with the created schedule.

Our newly created schedule now has our desired frequency (Sunday, Tuesday, Thursday, Saturday).

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6FYrDLk66DtP4gT6pZ%C2%A5q3j8=",
    "key": "mh5xrw8N4GrFKuVsbKMF6FYrDLk66DtP4gT6pZ¥q3j8=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9999",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": true,
        "monday": false,
        "tuesday": true,
        "wednesday": false,
        "thursday": true,
        "friday": false,
        "saturday": true
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEqDK3uOzFRCAUkrCdWj32y4=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "08:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZf1c="
        }
    ],
    "timestamp": "AAAAAAAZf1Q="
}

The original schedule (that we split) now has the opposite frequency.

{
    "href": "https://intelisys-api.intelisys.ca/RESTv1/schedules/mh5xrw8N4GrFKuVsbKMF6J0JS8%C6%92dhVKf%C2%A5QlVqb9NwRI=",
    "key": "mh5xrw8N4GrFKuVsbKMF6J0JS8ƒdhVKf¥QlVqb9NwRI=",
    "airlineCode": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/airlineCodes/YY",
        "code": "YY",
        "name": "Intelisys Air"
    },
    "flightNumber": "9999",
    "status": {
        "active": true,
        "cancelled": false
    },
    "validFrom": "2016-10-27 00:00:00Z",
    "validTo": "2017-10-25 00:00:00Z",
    "frequency": {
        "sunday": false,
        "monday": true,
        "tuesday": false,
        "wednesday": true,
        "thursday": false,
        "friday": true,
        "saturday": false
    },
    "aircraftModel": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/aircraftModels/2Qx%C2%A5GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "key": "2Qx¥GKVsZ08KvxdDQkIEbxdrGzWFvDSqgj1IS1NYsr4=",
        "identifier": "CRJ7",
        "name": "Canadair  CRA"
    },
    "flightType": {
        "href": "https://intelisys-api.intelisys.ca/RESTv1/flightTypes/S",
        "code": "S",
        "name": "Scheduled"
    },
    "flightCount": 0,
    "departure": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
            "code": "DCA",
            "name": "Washington International"
        }
    },
    "arrival": {
        "airport": {
            "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
            "code": "YYZ",
            "name": "Toronto Pearson Intl"
        }
    },
    "legs": [
        {
            "key": "1USCElijHYb0avSoDwoYEoEAfN3ScJvXKvc0LiGtJvY=",
            "legNumber": 1,
            "legStatus": {
                "active": true,
                "cancelled": false
            },
            "distance": {
                "length": 5975.92,
                "unitOfMeasurement": "km"
            },
            "departure": {
                "utcScheduledShortTime": "04:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/DCA",
                    "code": "DCA",
                    "name": "Washington International",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "arrival": {
                "utcScheduledShortTime": "08:00",
                "airport": {
                    "href": "https://intelisys-api.intelisys.ca/RESTv1/airports/YYZ",
                    "code": "YYZ",
                    "name": "Toronto Pearson Intl",
                    "utcOffset": {
                        "iso": "-04:00",
                        "hours": -4,
                        "minutes": -240
                    }
                }
            },
            "timestamp": "AAAAAAAZf1E="
        }
    ],
    "timestamp": "AAAAAAAZf08="
}


Related articles

Filter by label

There are no items with the selected labels at this time.