Products

Get specific equipment product

get

Retrieve a specific equipment product based on the manufacturer and device type.

Path parameters

manufacturerstringRequired

The manufacturer of the product.

deviceTypestringRequired

The type or model of the device.

Responses

200

Success

application/json

Represents a product or terminal.

manufacturerstringOptional

The manufacturer name of the product or terminal.

productNamestringOptional

The display or commercial name of the product.

modelIdinteger · int32Optional

Unique numeric identifier of the product model.

frontendsstring[]Optional

List of supported front-end interfaces or applications associated with the product.

productTypestring · enumOptional

The category of the product. Typically a terminal or device type.

Possible values:

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested product does not exist

application/json

get/api/equipment/products/{manufacturer}/{deviceType}

GET /api/equipment/products/{manufacturer}/{deviceType} HTTP/1.1
Accept: */*

{
  "manufacturer": "text",
  "productName": "text",
  "modelId": 1,
  "frontends": [
    "text"
  ],
  "productType": "Terminal",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  }
}

Get equipment products

get

Retrieve all equipment products that match the specified search criteria.

Query parameters

termstringOptional

A search term to filter products by keyword.

Default: ""

sizestringOptional

The number of records to return per page.

pagestringOptional

The page number of results to return in a paginated response.

sortstringOptional

The sorting criteria for the results. Possible values: by name or model.

isSoftwarebooleanOptional

Indicates whether to filter products that are software-based or hardware-based.

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

No Products found with search parameters

application/json

get/api/equipment/products

GET /api/equipment/products HTTP/1.1
Accept: */*

{
  "products": {
    "totalElements": 1,
    "totalPages": 1,
    "number": 1,
    "size": 1,
    "content": [
      {
        "manufacturer": "text",
        "productName": "text",
        "modelId": 1,
        "frontends": [
          "text"
        ],
        "productType": "Terminal",
        "metadata": {
          "exchangeId": "text",
          "timestamp": "text"
        }
      }
    ],
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "first": true,
    "numberOfElements": 1,
    "pageable": {
      "offset": 1,
      "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
      },
      "pageNumber": 1,
      "pageSize": 1,
      "unpaged": true,
      "paged": true
    },
    "last": true,
    "empty": true
  },
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  }
}