Scheduling

Create Visit Orders

Creates new visit orders for machines. The request body should include the details of the machines to be visited.

post/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/post.ts
A function with typed inputs. Its response is checked against the schema.

MachineIdinteger

The unique identifier of the machine for which the visit order is being created.

VisitDatestring date-time

The date and time when the machine is scheduled to be visited.

DriverIdstring uuid nullable

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

RouteIdinteger nullable

The unique identifier of the route associated with the machine visit. This field is nullable if the route is not specified.

OrderKeyinteger

The sequence order key indicating the position of the machine in the visit order.

The newly created visit orders.

VisitDatestring date-time

The date and time when the machine is scheduled to be visited.

MachineIdinteger nullable

The unique identifier of the machine associated with the visit order. This field is nullable if the machine ID is not available.

DriverIdstring uuid nullable

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

RouteIdinteger nullable

The unique identifier of the route associated with the machine visit. This field is nullable if the route is not specified.

OrderKeyinteger nullable

The sequence order key indicating the position of the machine in the visit order. This field is nullable if the order key is not defined.

CreatedDtstring date-time

The date and time when the visit order was created.

CreatedByinteger

The unique identifier of the user who created the visit order.

UpdatedDtstring date-time nullable

The date and time when the visit order was last updated. This field is nullable if no updates have been made.

UpdatedByinteger nullable

The unique identifier of the user who last updated the visit order. This field is nullable if no updates have been made.

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