@transreport/pauk-staff-api
    Preparing search index...

    Type Alias GetJourneyLegsParams

    Generated by orval v8.4.2 🍺 Do not edit manually. Staff API

    Staff API

    The Staff API provides endpoints for train operating company staff to manage passenger assistance.

    This API allows staff to:

    • View and manage assistance requests
    • Update booking statuses
    • Coordinate passenger support

    All endpoints require staff authentication credentials.

    OpenAPI spec version: v1

    type GetJourneyLegsParams = {
        alight_station_code_eq?: string;
        assignment_status_in?: string[];
        assistance_status_in?: string[];
        board_station_code_eq?: string;
        booking_ref_eq?: string;
        customer_contact_number_eq?: string;
        customer_email_eq?: string;
        customer_name?: string;
        customer_postcode_eq?: string;
        customer_ref_eq?: string;
        data_source_eq?: string;
        date_from?: string;
        date_to?: string;
        page?: number;
        per_page?: number;
        reservation_headcode_eq?: string;
        reservation_ref_eq?: string;
        station_code_eq?: string;
        status_eq?: string;
        train_operator?: string;
    }
    Index

    Properties

    alight_station_code_eq? assignment_status_in? assistance_status_in? board_station_code_eq? booking_ref_eq? customer_contact_number_eq? customer_email_eq? customer_name? customer_postcode_eq? customer_ref_eq? data_source_eq? date_from? date_to? page? per_page? reservation_headcode_eq? reservation_ref_eq? station_code_eq? status_eq? train_operator?

    Properties

    alight_station_code_eq?: string

    Filter by alight station CRS code

    assignment_status_in?: string[]

    Filter by assignment status (assigned/unassigned)

    assistance_status_in?: string[]

    Filter by assistance status

    board_station_code_eq?: string

    Filter by board station CRS code

    booking_ref_eq?: string

    Filter by booking reference

    customer_contact_number_eq?: string

    Filter by customer contact number

    customer_email_eq?: string

    Filter by customer email

    customer_name?: string

    Filter by customer name

    customer_postcode_eq?: string

    Filter by customer postcode

    customer_ref_eq?: string

    Filter by customer reference

    data_source_eq?: string

    Filter by data source

    date_from?: string

    Filter by date from (ISO 8601 date-time)

    date_to?: string

    Filter by date to (ISO 8601 date-time)

    Optionalpage

    page?: number

    Page number (default: 1)

    Optionalper_page

    per_page?: number

    Number of results per page (default: 25)

    reservation_headcode_eq?: string

    Filter by reservation headcode

    reservation_ref_eq?: string

    Filter by reservation reference

    station_code_eq?: string

    Filter by station CRS code (board or alight)

    status_eq?: string

    Filter by journey leg status

    train_operator?: string

    Filter by train operator

    Settings

    Member Visibility

    On This Page

    Staff API
    Properties