API Reference

/api/shift/external/roster/

Get shift assignments for a shift date and battalion visible in roster.

This endpoint returns comprehensive shift roster information including:

  1. date: The shift date being queried

  2. battalion: Basic information about the battalion (ID, name, etc.)

  3. stations: An array of stations assigned to the shift, including:

    • ID and name
    • Certification requirements
    • Apparatuses attached to each station with:
      • Name, ID, and model information
      • Whether the apparatus is for shift leaders
      • Associated positions with details like:
        • Position name and driver status
        • Associated rank information
        • Required certifications
        • Position start and end times
  4. shift_teams: Team information for the shift

  5. employees: Detailed information about scheduled employees:

    • Employee ID and name
    • Current rank information
    • Team assignment
    • Default pay codes (regular and overtime)
    • Note overrides
    • Custom fields configured for the roster
    • Certification information
  6. assignments: Comprehensive assignment details including:

    • Start and end times
    • Minimum start and maximum end times
    • Break durations
    • Reference data based on assignment type:
      • Position assignments (battalion, station, apparatus, position details,
        pay/detail codes, trade information)
      • Regular non-shift assignments (station/apparatus names, default pay codes)
      • Off assignments (type, employee, position information, pay codes, dates)
Language
Credentials
Click Try It! to start a request and see the response here!