Create New Route

Create New Route

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RouteName": "<string>",
  "RouteCode": "<string>",
  "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "RouteRemarks": "<string>",
  "RouteStatusId": 123
}
'

import requests

url = "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes"

payload = {
    "RouteName": "<string>",
    "RouteCode": "<string>",
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "RouteRemarks": "<string>",
    "RouteStatusId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    RouteName: '<string>',
    RouteCode: '<string>',
    DriverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    RouteRemarks: '<string>',
    RouteStatusId: 123
  })
};

fetch('https://qa-lynx.nayax.com/operational/v1/Scheduling/routes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'RouteName' => '<string>',
    'RouteCode' => '<string>',
    'DriverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'RouteRemarks' => '<string>',
    'RouteStatusId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes"

	payload := strings.NewReader("{\n  \"RouteName\": \"<string>\",\n  \"RouteCode\": \"<string>\",\n  \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"RouteRemarks\": \"<string>\",\n  \"RouteStatusId\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://qa-lynx.nayax.com/operational/v1/Scheduling/routes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"RouteName\": \"<string>\",\n  \"RouteCode\": \"<string>\",\n  \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"RouteRemarks\": \"<string>\",\n  \"RouteStatusId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/Scheduling/routes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"RouteName\": \"<string>\",\n  \"RouteCode\": \"<string>\",\n  \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"RouteRemarks\": \"<string>\",\n  \"RouteStatusId\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "RouteId": 123,
  "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "DriverName": "<string>",
  "DriverMobile": "<string>",
  "RouteName": "<string>",
  "RouteCode": "<string>",
  "RouteRemarks": "<string>",
  "RouteStatusId": 123,
  "RouteMachineCount": "<string>",
  "CreatedDt": "2023-11-07T05:31:56Z",
  "CreatedBy": 123,
  "UpdatedDt": "2023-11-07T05:31:56Z",
  "UpdatedBy": 123
}

Create New Route

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RouteName": "<string>",
  "RouteCode": "<string>",
  "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "RouteRemarks": "<string>",
  "RouteStatusId": 123
}
'

import requests

url = "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes"

payload = {
    "RouteName": "<string>",
    "RouteCode": "<string>",
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "RouteRemarks": "<string>",
    "RouteStatusId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    RouteName: '<string>',
    RouteCode: '<string>',
    DriverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    RouteRemarks: '<string>',
    RouteStatusId: 123
  })
};

fetch('https://qa-lynx.nayax.com/operational/v1/Scheduling/routes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'RouteName' => '<string>',
    'RouteCode' => '<string>',
    'DriverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'RouteRemarks' => '<string>',
    'RouteStatusId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes"

	payload := strings.NewReader("{\n  \"RouteName\": \"<string>\",\n  \"RouteCode\": \"<string>\",\n  \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"RouteRemarks\": \"<string>\",\n  \"RouteStatusId\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://qa-lynx.nayax.com/operational/v1/Scheduling/routes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"RouteName\": \"<string>\",\n  \"RouteCode\": \"<string>\",\n  \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"RouteRemarks\": \"<string>\",\n  \"RouteStatusId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/Scheduling/routes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"RouteName\": \"<string>\",\n  \"RouteCode\": \"<string>\",\n  \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"RouteRemarks\": \"<string>\",\n  \"RouteStatusId\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "RouteId": 123,
  "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "DriverName": "<string>",
  "DriverMobile": "<string>",
  "RouteName": "<string>",
  "RouteCode": "<string>",
  "RouteRemarks": "<string>",
  "RouteStatusId": 123,
  "RouteMachineCount": "<string>",
  "CreatedDt": "2023-11-07T05:31:56Z",
  "CreatedBy": 123,
  "UpdatedDt": "2023-11-07T05:31:56Z",
  "UpdatedBy": 123
}

Authorizations

Authorization

string

header

required

Enter your Bearer token. It's required to authenticate API requests.

Query Parameters

OperatorId

integer<int32>

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

Body

application/json

RouteName

string | null

The name of the route to be created.

RouteCode

string | null

The code used to identify the route to be created.

DriverId

string<uuid>

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

RouteRemarks

string | null

Additional remarks or notes related to the route.

RouteStatusId

integer<int32>

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

Response

200 - application/json

The newly created route details.

RouteId

integer<int64>

The unique identifier of the route.

DriverId

string<uuid> | null

The unique identifier of the driver assigned to the route.

DriverName

string | null

The name of the driver assigned to the route.

DriverMobile

string | null

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

RouteName

string | null

The name of the route.

RouteCode

string | null

The code used to identify the route.

RouteRemarks

string | null

Additional remarks or notes related to the route.

RouteStatusId

integer<int32>

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

RouteMachineCount

string | null

The number of machines assigned to the route.

CreatedDt

string<date-time>

The date and time when the route was created.

CreatedBy

integer<int64>

The identifier of the user who created the route.

UpdatedDt

string<date-time> | null

The date and time when the route was last updated.

UpdatedBy

integer<int64> | null

The identifier of the user who last updated the route.

Lynx API Guides

API Reference

Authorizations

Query Parameters

Body

Response