Scheduling

Get Visit Orders

Retrieves a list of visit orders based on various query parameters such as VisitDate, MachineId, DriverId, RouteId, and ActorId.

get/v1/Scheduling/schedule/visit-order

Request

Base URL
https://example.com:443
Auth
none required
TypeScript
https://skmtc.dev/nayax/apis/nayax-cortina-api/docs/v1/Scheduling/schedule/visit-order/get.ts
A function with typed inputs. Its response is checked against the schema.

VisitDatestring date-time

The date for which the visit orders are requested.

MachineIdinteger

The unique identifier of the machine associated with the visit order.

DriverIdstring uuid

The unique identifier of the driver associated with the visit order.

RouteIdinteger

The unique identifier of the route associated with the visit order.

ActorIdinteger

The unique identifier of the actor associated with the visit order.

A list of visit orders that match the specified criteria.

MachineVisitOrderIdinteger

The unique identifier for the visit order associated with a specific machine.

VisitDatestring date-time

The date and time when the visit is scheduled to occur.

DriverIdstring uuid nullable

The unique identifier of the driver assigned to the visit. This field is nullable if no driver is assigned.

No recorded changes to this operation across all 1 revision of this API.