Skip to main content
POST
/
v1
/
Scheduling
/
route-machines
Assign Machine to Route
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/route-machines \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "MachineIds": [
    123
  ]
}
'
[
  {
    "MachineTypeLutId": 123,
    "MachineId": 123,
    "MachineName": "<string>",
    "MachineNumber": "<string>",
    "CountryId": 123,
    "City": "<string>",
    "Address": "<string>",
    "StreetNumber": "<string>",
    "Longitude": "<string>",
    "Latitude": "<string>",
    "InstituteId": 123,
    "InstituteName": "<string>",
    "LocationId": 123,
    "LocationName": "<string>",
    "CustomerId": 123,
    "CustomerName": "<string>",
    "CustomerLocationId": 123,
    "CustomerLocationName": "<string>",
    "StatusId": 123,
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "RouteId": 123,
    "UserId": 123,
    "CreatedBy": 123,
    "CreatedDt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Query Parameters

​
RouteId
integer<int32>

The unique identifier of the route to which the machine will be assigned.

Body

application/json
​
MachineIds
integer<int64>[] | null

A list of unique identifiers for the machines to be assigned to the route. Each MachineId corresponds to a machine that will be associated with the specified route.

Response

200 - application/json

The details of the machine assigned to the route.

​
MachineTypeLutId
integer<int32> | null

The identifier for the machine type from the lookup table.

​
MachineId
integer<int64>

The unique identifier of the machine.

​
MachineName
string | null

The name of the machine.

​
MachineNumber
string | null

The unique number assigned to the machine.

​
CountryId
integer<int32> | null

The identifier for the country where the machine is located.

​
City
string | null

The city where the machine is located.

​
Address
string | null

The address where the machine is located.

​
StreetNumber
string | null

The street number where the machine is located.

​
Longitude
string | null

The longitude coordinate of the machine's location.

​
Latitude
string | null

The latitude coordinate of the machine's location.

​
InstituteId
integer<int64> | null

The unique identifier of the institute associated with the machine.

​
InstituteName
string | null

The name of the institute associated with the machine.

​
LocationId
integer<int64> | null

The unique identifier of the location where the machine is installed.

​
LocationName
string | null

The name of the location where the machine is installed.

​
CustomerId
integer<int64> | null

The unique identifier of the customer associated with the machine.

​
CustomerName
string | null

The name of the customer associated with the machine.

​
CustomerLocationId
integer<int64> | null

The unique identifier of the customer's location associated with the machine.

​
CustomerLocationName
string | null

The name of the customer's location associated with the machine.

​
StatusId
integer<int32> | null

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

​
DriverId
string<uuid> | null

The unique identifier of the driver assigned to the machine.

​
RouteId
integer<int64>

The unique identifier of the route to which the machine is assigned.

​
UserId
integer<int64> | null

The unique identifier of the user who last interacted with the machine.

​
CreatedBy
integer<int64>

The unique identifier of the user who created the route-machine association.

​
CreatedDt
string<date-time>

The date and time when the route-machine association was created.