Scheduling

Create New Route

Creates a new route for the specified operator. The request body should include the details of the route to be created.

post/v1/Scheduling/routes

Request

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

Query parameters

OperatorIdinteger

The unique identifier of the operator for whom the route is being created.

Request body

RouteNamestring nullable

The name of the route to be created.

RouteCodestring nullable

The code used to identify the route to be created.

DriverIdstring uuid

The unique identifier of the driver to be assigned to the route.

RouteRemarksstring nullable

Additional remarks or notes related to the route.

RouteStatusIdinteger

The status identifier of the route, indicating its initial status.

Response

The newly created route details.

RouteIdinteger

The unique identifier of the route.

DriverIdstring uuid nullable

The unique identifier of the driver assigned to the route.

DriverNamestring nullable

The name of the driver assigned to the route.

DriverMobilestring nullable

The mobile phone number of the driver assigned to the route.

RouteNamestring nullable

The name of the route.

RouteCodestring nullable

The code used to identify the route.

RouteRemarksstring nullable

Additional remarks or notes related to the route.

RouteStatusIdinteger

The status identifier of the route, indicating its current status.

RouteMachineCountstring nullable

The number of machines assigned to the route.

CreatedDtstring date-time

The date and time when the route was created.

CreatedByinteger

The identifier of the user who created the route.

UpdatedDtstring date-time nullable

The date and time when the route was last updated.

UpdatedByinteger nullable

The identifier of the user who last updated the route.

Changes

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