Schedules

Events

Action Event name
create a new schedule schedule.created
update an existing schedule schedule.updated
add a child schedule schedule.updated
remove the child schedule schedule.updated
delete an existing schedule schedule.deleted

Payload example created

{
  "attemptId": "d8920968-aaee-4315-8321-6d9edf084fef",
  "created": 1734385029,
  "data": {
    "serviceNumberId": null,
    "accountId": "52a377ec430c7d4e220001fc",
    "id": "6a708bcf-6829-4641-8314-471df9334e57",
    "createdBy": "55fc2f318791db6e1a0000b6",
    "legs": [
      {
        "arrival": "06:15",
        "collapsed": true,
        "departure": "06:00",
        "distance": 15,
        "duration": 15,
        "from": "As",
        "fromId": "52a378c1430c7d4e2200020c",
        "fromLetter": "A",
        "hideWhenPrintingManifest": false,
        "legord": 0,
        "requiresCheckIn": false,
        "to": "B (testB)",
        "toId": "52a378c8430c7d4e2200020e",
        "toLetter": "B"
      },
      {
        "arrival": "07:15",
        "collapsed": true,
        "departure": "06:15",
        "distance": 0,
        "duration": 60,
        "from": "B (testB)",
        "fromId": "52a378c8430c7d4e2200020e",
        "fromLetter": "B",
        "hideWhenPrintingManifest": false,
        "legord": 1,
        "requiresCheckIn": false,
        "to": "C2",
        "toId": "52a37bf1430c7d4e22000226",
        "toLetter": "C",
        "waitTime": 0
      }
    ],
    "duration": 75,
    "fromDate": "12/18/2024",
    "routeId": "63c158c0ebd42e06d002a0e2",
    "toId": "52a37bf1430c7d4e22000226",
    "dow": {
      "friday": "Y",
      "holiday": "N",
      "holidaysIncluded": "N",
      "holidaysOnly": "N",
      "monday": "N",
      "saturday": "N",
      "sunday": "N",
      "thursday": "Y",
      "tuesday": "N",
      "wednesday": "N"
    },
    "inventoryId": "",
    "isExtraRun": false,
    "amenityGroupIds": [],
    "autoBouncingChanges": {
      "currentSchedule": {},
      "newParentSchedule": null,
      "toRemove": null
    },
    "to": "C2",
    "routeName": "A - B",
    "operatingCompanyInfoOnPrintedTicket": null,
    "operatingCompanyId": "",
    "taxExempt": false,
    "updatedAt": {
      "offset": 0,
      "value": "2024-12-16T21:37:01.251Z"
    },
    "operatingCompanyName": null,
    "serviceNumberName": null,
    "toDateYYYYMMDD": "2024-12-25",
    "fromDateYYYYMMDD": "2024-12-18",
    "scheduleGroupName": "New name",
    "from": "As",
    "newdesign": true,
    "distance": 15,
    "toDate": "12/25/2024",
    "createdAt": {
      "offset": 0,
      "value": "2024-12-16T21:37:01.250Z"
    },
    "brandName": null,
    "defaultManifestStatus": "published",
    "requiresCheckIn": false,
    "scheduleGroupId": "675b06d5994c2747c5d685b9",
    "capacity": 0,
    "labelIds": [],
    "controlPoints": [],
    "amenityGroupId": "",
    "standingPassengerCapacity": 0,
    "displayName": "test",
    "passengerLimits": [],
    "time": "06:00",
    "externalId": "12345678",
    "seatMapId": "",
    "name": "6a708bcf-6829-4641-8314-471df9334e57",
    "brandId": "",
    "fromId": "52a378c1430c7d4e2200020c",
    "labels": []
  },
  "event": "schedule.created",
  "id": "7153703d-4ab2-461a-921c-58603e481b2c",
  "livemode": true
}

Payload example updated

{
  "attemptId": "2a5841f0-c23f-4e8a-88f4-2fe7a60416d0",
  "created": 1734384934,
  "data": {
    "serviceNumberId": null,
    "accountId": "52a377ec430c7d4e220001fc",
    "id": "41ff89bb-95f5-4680-986a-a386ad22d431",
    "createdBy": "62179884ebb34d07f9a14cdc",
    "legs": [
      {
        "arrival": "12:00",
        "collapsed": true,
        "departure": "11:00",
        "distance": 15,
        "duration": 15,
        "from": "As",
        "fromId": "52a378c1430c7d4e2200020c",
        "fromLetter": "A",
        "hideWhenPrintingManifest": false,
        "legord": 0,
        "requiresCheckIn": true,
        "to": "B (testB)",
        "toId": "52a378c8430c7d4e2200020e",
        "toLetter": "B"
      },
      {
        "arrival": "12:30",
        "collapsed": true,
        "departure": "12:00",
        "distance": 13,
        "duration": 12,
        "from": "B (testB)",
        "fromId": "52a378c8430c7d4e2200020e",
        "fromLetter": "B",
        "hideWhenPrintingManifest": false,
        "legord": 1,
        "requiresCheckIn": true,
        "to": "C",
        "toId": "52a378dc430c7d4e22000211",
        "toLetter": "C",
        "waitTime": 0
      },
      {
        "arrival": "13:00",
        "collapsed": true,
        "departure": "12:30",
        "distance": 30,
        "duration": 20,
        "from": "C",
        "fromId": "52a378dc430c7d4e22000211",
        "fromLetter": "C",
        "hideWhenPrintingManifest": false,
        "legord": 2,
        "requiresCheckIn": true,
        "to": "D",
        "toId": "52a3793d430c7d4e22000213",
        "toLetter": "D",
        "waitTime": 0
      }
    ],
    "duration": 120,
    "fromDate": "10/01/2015",
    "routeId": "52c9feb265371a6d0e0001a3",
    "toId": "52a3793d430c7d4e22000213",
    "dow": {
      "friday": "Y",
      "holiday": "N",
      "holidaysIncluded": "Y",
      "holidaysOnly": "N",
      "monday": "Y",
      "saturday": "Y",
      "sunday": "Y",
      "thursday": "Y",
      "tuesday": "Y",
      "wednesday": "Y"
    },
    "inventoryId": "",
    "isExtraRun": false,
    "amenityGroupIds": [
      "6050ff7e96f4cea484566622"
    ],
    "to": "D",
    "routeName": "FareEx",
    "operatingCompanyInfoOnPrintedTicket": "This information should\nbe printed in the ticket",
    "operatingCompanyId": "611bbe812fccef3a94f9b00b",
    "taxExempt": false,
    "updatedAt": {
      "offset": 0,
      "value": "2024-12-16T21:35:23.001Z"
    },
    "operatingCompanyName": "HOPITAL MAISONNEUVE ROSEMONT",
    "updatedBy": "62179884ebb34d07f9a14cdc",
    "serviceNumberName": null,
    "toDateYYYYMMDD": "2040-01-01",
    "taxExemptionLog": [
      {
        "createdAt": {
          "offset": 0,
          "value": "2024-10-21T17:00:46.926Z"
        },
        "type": "Removal",
        "useId": "55fc2f318791db6e1a0000b6"
      }
    ],
    "fromDateYYYYMMDD": "2015-10-01",
    "scheduleGroupName": "",
    "from": "As",
    "distance": 58,
    "toDate": "01/01/2040",
    "brandName": "Another brand",
    "defaultManifestStatus": "published",
    "requiresCheckIn": true,
    "scheduleGroupId": "",
    "capacity": 500,
    "controlPoints": [
      {
        "expectedOffset": 0,
        "stationId": "52a378c1430c7d4e2200020c"
      },
      {
        "expectedOffset": 0,
        "stationId": "66686eba68b1920502c4a9b9"
      }
    ],
    "amenityGroupId": "6050ff7e96f4cea484566622",
    "standingPassengerCapacity": 0,
    "displayName": "11:00",
    "passengerLimits": [],
    "time": "11:00",
    "externalId": "12345",
    "seatMapId": "",
    "name": "41ff89bb-95f5-4680-986a-a386ad22d431",
    "brandId": "62d9913cbab856fbb57716e0",
    "fromId": "52a378c1430c7d4e2200020c",
    "labels": []
  },
  "event": "schedule.updated",
  "id": "1277c936-83d4-4d9e-ab9f-99b70601dea4",
  "livemode": true
}

Deleted payload example

{
    "attemptId": "3f962294-3382-4e4f-a078-15b83714033e",
    "created": 1725459554,
    "data": {
      "id": "d125b58d-2b6d-4dd2-af3b-f9913ac493ac",
      "controlPoints": [
        {
          "expectedOffset": 0,
          "stationId": "52a378c1430c7d4e2200020c"
        },
        {
          "expectedOffset": 0,
          "stationId": "66686eba68b1920502c4a9b9"
        }
      ]
    },
    "event": "schedule.deleted",
    "id": "002c5f7f-04c5-4a80-8688-78c1f9d4d979",
    "livemode": false
}