Get Provision Values

1. Overview

This endpoint allows users to retrieve existing provision values for a device from the database using XML configuration data. The method queries various database tables including provision, cpe_provision, and cpe_provision_history to extract all parameters, objects, and services associated with the specified device.

Unlike the provisioning endpoints that actively configure devices, this method is read-only and designed for querying existing provisioning data.

2. Functionality and usage

2.1. Input format

The endpoint accepts XML data containing device configuration. The XML should include:

  • Device identifier – Serial Number (SN)

  • Params section – Parameters with their IDs and service associations

  • Objects section – Complex objects with nested parameters and sub-objects

  • Services section – List of services to be queried

2.2. XML structure example

The XML format for retrieving provision values uses a simplified schema where you only specify which parameters, objects, and services you want to retrieve:

<?xml version="1.0" encoding="UTF-8"?>
<device sn="string">
    <params>
        <param name="string" />
    </params>
    <objects>
        <object name="string" />
    </objects>
    <services>
        <service id="string" />
    </services>
</device>

2.3. Response format

The endpoint returns a VDevice object containing the following information:

  • serialNumber – Device serial number

  • parameters – Array of parameter objects with their current values from the database

  • objects – Array of complex objects with nested parameters and sub-objects

  • services – Array of services associated with the device

Example response:

{
  "serialNumber": "ABC123",
  "parameters": [],
  "objects": [],
  "services": []
}

2.4. Use cases

  • Configuration verification – Check what provisioning values are currently stored for a device

  • Data inspection – Review historical provisioning data before making changes

  • Debugging – Verify that provisioning data was correctly saved to the database

  • Integration – Query device configuration for external systems or reporting

2.5. Database tables queried

The method retrieves data from multiple database tables:

  • cpe_provision – CPE-specific provisioning records

  • cpe_provision_history – Historical provisioning data

  • prov – Main provisioning data table

This is a read-only operation and does not modify any data in the database or on the device.
The device must exist in the database to return meaningful results. If the device is not found, an empty or minimal response will be returned.