Create Visit Orders
curl --request POST \
--url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"MachineId": 123,
"VisitDate": "2023-11-07T05:31:56Z",
"DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"RouteId": 123,
"OrderKey": 123
}
]
'import requests
url = "https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order"
payload = [
{
"MachineId": 123,
"VisitDate": "2023-11-07T05:31:56Z",
"DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"RouteId": 123,
"OrderKey": 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([
{
MachineId: 123,
VisitDate: '2023-11-07T05:31:56Z',
DriverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
RouteId: 123,
OrderKey: 123
}
])
};
fetch('https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order', 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/schedule/visit-order",
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([
[
'MachineId' => 123,
'VisitDate' => '2023-11-07T05:31:56Z',
'DriverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'RouteId' => 123,
'OrderKey' => 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/schedule/visit-order"
payload := strings.NewReader("[\n {\n \"MachineId\": 123,\n \"VisitDate\": \"2023-11-07T05:31:56Z\",\n \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"RouteId\": 123,\n \"OrderKey\": 123\n }\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/schedule/visit-order")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"MachineId\": 123,\n \"VisitDate\": \"2023-11-07T05:31:56Z\",\n \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"RouteId\": 123,\n \"OrderKey\": 123\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order")
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 {\n \"MachineId\": 123,\n \"VisitDate\": \"2023-11-07T05:31:56Z\",\n \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"RouteId\": 123,\n \"OrderKey\": 123\n }\n]"
response = http.request(request)
puts response.read_body[
{
"VisitDate": "2023-11-07T05:31:56Z",
"MachineId": 123,
"DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"RouteId": 123,
"OrderKey": 123,
"CreatedDt": "2023-11-07T05:31:56Z",
"CreatedBy": 123,
"UpdatedDt": "2023-11-07T05:31:56Z",
"UpdatedBy": 123
}
]Scheduling
Create Visit Orders
Creates new visit orders for machines. The request body should include the details of the machines to be visited.
Create Visit Orders
curl --request POST \
--url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"MachineId": 123,
"VisitDate": "2023-11-07T05:31:56Z",
"DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"RouteId": 123,
"OrderKey": 123
}
]
'import requests
url = "https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order"
payload = [
{
"MachineId": 123,
"VisitDate": "2023-11-07T05:31:56Z",
"DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"RouteId": 123,
"OrderKey": 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([
{
MachineId: 123,
VisitDate: '2023-11-07T05:31:56Z',
DriverId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
RouteId: 123,
OrderKey: 123
}
])
};
fetch('https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order', 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/schedule/visit-order",
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([
[
'MachineId' => 123,
'VisitDate' => '2023-11-07T05:31:56Z',
'DriverId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'RouteId' => 123,
'OrderKey' => 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/schedule/visit-order"
payload := strings.NewReader("[\n {\n \"MachineId\": 123,\n \"VisitDate\": \"2023-11-07T05:31:56Z\",\n \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"RouteId\": 123,\n \"OrderKey\": 123\n }\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/schedule/visit-order")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"MachineId\": 123,\n \"VisitDate\": \"2023-11-07T05:31:56Z\",\n \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"RouteId\": 123,\n \"OrderKey\": 123\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order")
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 {\n \"MachineId\": 123,\n \"VisitDate\": \"2023-11-07T05:31:56Z\",\n \"DriverId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"RouteId\": 123,\n \"OrderKey\": 123\n }\n]"
response = http.request(request)
puts response.read_body[
{
"VisitDate": "2023-11-07T05:31:56Z",
"MachineId": 123,
"DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"RouteId": 123,
"OrderKey": 123,
"CreatedDt": "2023-11-07T05:31:56Z",
"CreatedBy": 123,
"UpdatedDt": "2023-11-07T05:31:56Z",
"UpdatedBy": 123
}
]Authorizations
Body
application/json
Response
200 - application/json
The newly created visit orders.
Was this page helpful?