Duty Events

A duty event (or period) represents part or all of a workday.

Concepts

Duty events should describe an individual’s complete duty day (workday): from when and where the individual started duty to when and where the individual completed duty.

Some operators define pre-flight duty (e.g. 1.5 hours prior to takeoff) and post-flight duty (e.g. 1 hour after landing). In this example, a duty event describing a day of flying would begin 1.5 hours before scheduled takeoff and end 1 hour after the final scheduled landing time.

The duty event does not need to contain the individual flights. FlightRisk will automatically overlay the schedule data on top of the duty event to calculate when a crew member is able to rest, and if that rest is aligned with their circadian rhythm.

Use this API to send at least one duty event per workday. Events should not overlap.

Duty events image — FlightRisk Uses duty events (green) combined with schedule data (blue) to determine the work/sleep cycles of a crew member.

/DutyEvents/Current

HTTP PUT Service Accounts

Makes the specified list of duty events the current duty for a user account in Vocus.

Any other events for the user are marked as superseded, i.e. only the new events will be considered in calculations. Pass at least ±3 weeks of data for the best results.

Send duty events frequently: as the data changes, or multiple times per day if not using change tracking. Granular change tracking is not necessary; any change to a person's duty should trigger a sync.

Input

Field Type Constraints Detail

accountId Mapped ID Required

dutyEvents

Array

Field	Type	Constraints	Detail
startAirfieldCode	Airfield Code	Required
startDate	Date	Required
endAirfieldCode	Airfield Code	Required
endDate	Date	Required
type	String	Required	Accepted Values `duty` `flight` `position` `training` `simulator` `briefing` `debriefing` `sitTime`

Sample Payload

        var payload = {
            accountId: "callers_account_ID_12345",
            dutyEvents: [{
              startAirfieldCode: "kphx",
              startDate: "2019-05-23T16:00:00.000Z",
              endAirfieldCode: "klax",
              endDate: "2019-05-24T00:00:00.000Z",
              type: "flight"
            }, {
              startAirfieldCode: "klax",
              startDate: "2019-05-24T16:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-05-25T00:00:00.000Z",
              type: "flight"
            }, {
              startAirfieldCode: "kphx",
              startDate: "2019-05-26T16:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-05-27T00:00:00.000Z",
              type: "duty"
            }, {
              startAirfieldCode: "kphx",
              startDate: "2019-05-27T16:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-05-28T00:00:00.000Z",
              type: "training"
            }, {
              startAirfieldCode: "kphx",
              startDate: "2019-05-28T16:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-05-28T20:00:00.000Z",
              type: "training"
            }, {
              startAirfieldCode: "kphx",
              startDate: "2019-05-28T20:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-05-29T00:00:00.000Z",
              type: "simulator"
            }, {
              startAirfieldCode: "kphx",
              startDate: "2019-05-31T16:00:00.000Z",
              endAirfieldCode: "kden",
              endDate: "2019-06-01T00:00:00.000Z",
              type: "flight"
            }, {
              startAirfieldCode: "kden",
              startDate: "2019-06-01T16:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-06-01T20:00:00.000Z",
              type: "position"
            }, {
              startAirfieldCode: "kphx",
              startDate: "2019-06-01T20:00:00.000Z",
              endAirfieldCode: "klax",
              endDate: "2019-06-02T02:00:00.000Z",
              type: "flight"
            }, {
              startAirfieldCode: "klax",
              startDate: "2019-06-02T16:00:00.000Z",
              endAirfieldCode: "kphx",
              endDate: "2019-06-03T00:00:00.000Z",
              type: "flight"
            }]
        };

Output

See HTTP Response Codes

HTTP Status	Data
200

API Version 14.1.9203.25168