Bulk Update Machine Attributes - Nayax Developer Portal

Bulk Update Machine Attributes

curl --request PUT \
  --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "DeviceAttributeID": 123,
    "MachineID": 123,
    "DeviceAttributeValue": "<string>",
    "DeviceAttributeCodeID": 123,
    "DeviceAttributeName": "<string>",
    "DeviceAttributeGroup": "<string>",
    "DeviceAttributeReadOnlyBit": true
  }
]
'

import requests

url = "https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes"

payload = [
    {
        "DeviceAttributeID": 123,
        "MachineID": 123,
        "DeviceAttributeValue": "<string>",
        "DeviceAttributeCodeID": 123,
        "DeviceAttributeName": "<string>",
        "DeviceAttributeGroup": "<string>",
        "DeviceAttributeReadOnlyBit": True
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      DeviceAttributeID: 123,
      MachineID: 123,
      DeviceAttributeValue: '<string>',
      DeviceAttributeCodeID: 123,
      DeviceAttributeName: '<string>',
      DeviceAttributeGroup: '<string>',
      DeviceAttributeReadOnlyBit: true
    }
  ])
};

fetch('https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes', 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/machines/{MachineID}/attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'DeviceAttributeID' => 123,
        'MachineID' => 123,
        'DeviceAttributeValue' => '<string>',
        'DeviceAttributeCodeID' => 123,
        'DeviceAttributeName' => '<string>',
        'DeviceAttributeGroup' => '<string>',
        'DeviceAttributeReadOnlyBit' => true
    ]
  ]),
  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/machines/{MachineID}/attributes"

	payload := strings.NewReader("[\n  {\n    \"DeviceAttributeID\": 123,\n    \"MachineID\": 123,\n    \"DeviceAttributeValue\": \"<string>\",\n    \"DeviceAttributeCodeID\": 123,\n    \"DeviceAttributeName\": \"<string>\",\n    \"DeviceAttributeGroup\": \"<string>\",\n    \"DeviceAttributeReadOnlyBit\": true\n  }\n]")

	req, _ := http.NewRequest("PUT", 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.put("https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"DeviceAttributeID\": 123,\n    \"MachineID\": 123,\n    \"DeviceAttributeValue\": \"<string>\",\n    \"DeviceAttributeCodeID\": 123,\n    \"DeviceAttributeName\": \"<string>\",\n    \"DeviceAttributeGroup\": \"<string>\",\n    \"DeviceAttributeReadOnlyBit\": true\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"DeviceAttributeID\": 123,\n    \"MachineID\": 123,\n    \"DeviceAttributeValue\": \"<string>\",\n    \"DeviceAttributeCodeID\": 123,\n    \"DeviceAttributeName\": \"<string>\",\n    \"DeviceAttributeGroup\": \"<string>\",\n    \"DeviceAttributeReadOnlyBit\": true\n  }\n]"

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

{
  "isFullySuccess": true,
  "failureItems": [
    {
      "id": "<string>",
      "error": "<string>"
    }
  ]
}

Bulk Update Machine Attributes

curl --request PUT \
  --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "DeviceAttributeID": 123,
    "MachineID": 123,
    "DeviceAttributeValue": "<string>",
    "DeviceAttributeCodeID": 123,
    "DeviceAttributeName": "<string>",
    "DeviceAttributeGroup": "<string>",
    "DeviceAttributeReadOnlyBit": true
  }
]
'

import requests

url = "https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes"

payload = [
    {
        "DeviceAttributeID": 123,
        "MachineID": 123,
        "DeviceAttributeValue": "<string>",
        "DeviceAttributeCodeID": 123,
        "DeviceAttributeName": "<string>",
        "DeviceAttributeGroup": "<string>",
        "DeviceAttributeReadOnlyBit": True
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      DeviceAttributeID: 123,
      MachineID: 123,
      DeviceAttributeValue: '<string>',
      DeviceAttributeCodeID: 123,
      DeviceAttributeName: '<string>',
      DeviceAttributeGroup: '<string>',
      DeviceAttributeReadOnlyBit: true
    }
  ])
};

fetch('https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes', 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/machines/{MachineID}/attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'DeviceAttributeID' => 123,
        'MachineID' => 123,
        'DeviceAttributeValue' => '<string>',
        'DeviceAttributeCodeID' => 123,
        'DeviceAttributeName' => '<string>',
        'DeviceAttributeGroup' => '<string>',
        'DeviceAttributeReadOnlyBit' => true
    ]
  ]),
  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/machines/{MachineID}/attributes"

	payload := strings.NewReader("[\n  {\n    \"DeviceAttributeID\": 123,\n    \"MachineID\": 123,\n    \"DeviceAttributeValue\": \"<string>\",\n    \"DeviceAttributeCodeID\": 123,\n    \"DeviceAttributeName\": \"<string>\",\n    \"DeviceAttributeGroup\": \"<string>\",\n    \"DeviceAttributeReadOnlyBit\": true\n  }\n]")

	req, _ := http.NewRequest("PUT", 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.put("https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"DeviceAttributeID\": 123,\n    \"MachineID\": 123,\n    \"DeviceAttributeValue\": \"<string>\",\n    \"DeviceAttributeCodeID\": 123,\n    \"DeviceAttributeName\": \"<string>\",\n    \"DeviceAttributeGroup\": \"<string>\",\n    \"DeviceAttributeReadOnlyBit\": true\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/attributes")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"DeviceAttributeID\": 123,\n    \"MachineID\": 123,\n    \"DeviceAttributeValue\": \"<string>\",\n    \"DeviceAttributeCodeID\": 123,\n    \"DeviceAttributeName\": \"<string>\",\n    \"DeviceAttributeGroup\": \"<string>\",\n    \"DeviceAttributeReadOnlyBit\": true\n  }\n]"

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

{
  "isFullySuccess": true,
  "failureItems": [
    {
      "id": "<string>",
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

MachineID

integer<int64>

required

The unique identifier of the machine whose attributes are being updated.

Body

application/json

DeviceAttributeID

integer<int64>

The unique identifier of the device attribute.

MachineID

integer<int64>

The unique identifier of the machine associated with this attribute.

DeviceAttributeValue

string | null

The value assigned to this device attribute.

DeviceAttributeCodeID

integer<int32> | null

The code identifier for this device attribute.

DeviceAttributeName

string | null

The name of the device attribute.

DeviceAttributeGroup

string | null

The group or category to which this device attribute belongs.

DeviceAttributeReadOnlyBit

boolean

Indicates whether the device attribute is read-only.

Response

200 - application/json

The result of the bulk update operation, including success and any failure details.

Represents the result of a bulk update operation, indicating overall success and details of any failed updates.

isFullySuccess

boolean

Indicates whether the bulk update operation was fully successful.

failureItems

object[] | null

A list of items that failed to update, including error details.

Show child attributes