Inventory Device Serial Operation

UpdatesThe Inventory Device Serial Operation API provides functionality to update device inventory information using theserial device'snumbers as identifiers. This endpoint is designed for bulk device management operations where you need to modify device attributes or settings directly by serial number.number, making it ideal for inventory management systems and device provisioning workflows.

Base URL: https://control.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Inventory Device Serial Operation API category contains endpoints specifically designed for device management operations that target devices by their unique serial numbers. This approach is particularly useful when integrating with external systems that primarily identify devices by serial numbers rather than internal database IDs.

This API is commonly used in scenarios where:

External inventory management systems need to sync device data Bulk device configuration updates are required Device provisioning workflows need to update device status or attributes Asset management systems need to modify device properties

The serial number-based approach eliminates the need to first query for device IDs, streamlining operations where serial numbers are the primary identifier. This is especially valuable in enterprise environments where serial numbers are used for device tracking and management.

---

Endpoints

PUT /inventory_device_serial_operation/{serial_number}/

Description: Updates inventorydevice information and configuration for a specific device identified by its serial number. This endpoint allows you to modify device details,attributes, status, location,configuration settings, and other properties without needing to know the internal device ID. It's designed for bulk operations and integration with external systems that use serial numbers as primary identifiers.

Use Cases:

Updating device status during deployment or otherdecommissioning inventory-relatedprocesses properties.Modifying device configuration settings during provisioning Syncing device information from external asset management systems Bulk updating device attributes during inventory reconciliation Setting device location, assignment, or organizational unit information

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_operation/ABC123456789/

Parameters:

Parameter	Type	In	Required	Description
serial_number	string	path	Yes	UniqueThe unique serial number of the device to update
data	string	body	Yes	JSON payloadstring containing the device informationproperties to update

ExamplecURL Request:Example:

curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_serial_operation/SN123456789/ABC123456789/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/jsonjson" Authorization:\
  Bearer-d <your-api-token>

'{
    "device_name"name": "Laptop-HR-001"Conference Room Laptop",
    "status": "active",
    "location": "Building A - FloorRoom 2"101",
    "assigned_user": "john.doe@company.com",
    "department"organization_unit": "HumanIT Resources"Department",
    "purchase_date"configuration": {
      "auto_update": true,
      "backup_enabled": true,
      "encryption_status": "2023-08-15"enabled"
    },
    "warranty_expiry"tags": ["2026-08-15"laptop", "notes":conference-room", "Updated RAM to 16GB"windows"]
  }'

Example Response:Request Body:

{
  "serial_number"name": "SN123456789",Conference "device_name":Room "Laptop-HR-001"Laptop",
  "status": "active",
  "location": "Building A - FloorRoom 2"101",
  "assigned_user": "john.doe@company.com",
  "department"organization_unit": "HumanIT Resources"Department",
  "device_type": "laptop",
  "manufacturer": "Dell",
  "model": "Latitude 5520",
  "configuration": {
    "auto_update": true,
    "backup_enabled": true,
    "encryption_status": "enabled",
    "compliance_profile": "corporate-standard"
  },
  "custom_fields": {
    "purchase_date": "2023-08-2024-01-15",
    "warranty_expiry": "2026-08-2027-01-15",
    "notes"cost_center": "UpdatedIT-001"
  RAM to 16GB"},
  "last_updated"tags": ["laptop", "conference-room", "windows"]
}

Example Response:

{
  "id": 1247,
  "serial_number": "2023-11-ABC123456789",
  "name": "Conference Room Laptop",
  "status": "active",
  "location": "Building A - Room 101",
  "assigned_user": "john.doe@company.com",
  "organization_unit": "IT Department",
  "device_type": "laptop",
  "manufacturer": "Dell",
  "model": "Latitude 5520",
  "configuration": {
    "auto_update": true,
    "backup_enabled": true,
    "encryption_status": "enabled",
    "compliance_profile": "corporate-standard"
  },
  "custom_fields": {
    "purchase_date": "2024-01-15",
    "warranty_expiry": "2027-01-15",
    "cost_center": "IT-001"
  },
  "tags": ["laptop", "conference-room", "windows"],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-03-15T14:22:33Z",
  "last_seen": "2024-03-15T14:20:15Z"
}

Response Codes:

Status	Description
200	Success - Device informationupdated successfully updatedwith the new information
400	Bad requestRequest - invalidInvalid data format or missing required fields
401	Unauthorized - invalidInvalid or missing authenticationAPI token
404	Not Found - Device with the specified serial number does not foundexist
422	Unprocessable entityEntity - validationValid errorsJSON inbut the providedinvalid data values
500	Internal serverServer Error - Server-side error during processing

---

Common Use Cases

Use Case 1: Device Deployment Automation

When deploying devices to end users, update device status, assigned user, and location information using the device's serial number. This is typically integrated into device provisioning workflows where the serial number is scanned or entered during the deployment process.

Use Case 2: Asset Management Integration

Sync device information from external asset management systems that use serial numbers as primary identifiers. Update device location, cost center, warranty information, and other asset-related properties without needing to map to internal IDs.

Use Case 3: Bulk Configuration Updates

Apply configuration changes to multiple devices by serial number during compliance updates or security policy changes. This allows for batch processing where each device is identified by its unique serial number.

Use Case 4: Inventory Reconciliation

Update device information during physical inventory audits where devices are identified by their serial numbers. Correct location information, update status, and modify other attributes based on physical verification.

Use Case 5: Device Lifecycle Management

Update device status and configuration during different lifecycle phases (deployment, active use, maintenance, decommissioning) using the serial number as the consistent identifier throughout the device's lifecycle.

---

Best Practices

• Validate Serial Number FormatNumbers: EnsureAlways theensure serial numbernumbers are properly formatted and exist in the URLsystem pathbefore exactlymaking matchesupdate therequests device'sto registeredavoid serial404 numbererrors.

  (case-sensitive)

• Use Partial Updates: You canOnly include only the fields youthat wantneed to updatebe updated in the request bodybody. -The unchangedAPI fieldssupports willpartial retainupdates, theirso currentyou valuesdon't need to send the entire device object.

• Batch Operations: When updating multiple devices, implement proper rate limiting and consider processing devices in batches to avoid overwhelming the API.

Error Handling: Implement robust error handling for common scenarios like device not found (404) or invalid data (400/422). Log failed operations for troubleshooting and retry mechanisms.

Data Validation: Validate datedevice formatsdata (YYYY-MM-DD)on andthe emailclient addressesside before sending requestsrequests, especially for fields like email addresses, dates, and enumerated values like status.

ErrorIdempotent HandlingOperations: AlwaysDesign checkyour integration to be idempotent - the responsesame statusupdate codeoperation andshould handlebe 404safe errorsto forretry non-existentwithout serialcausing numbersunintended side effects.

Rate Limiting: Implement appropriate delays between bulk update operations to avoid overwhelming the API

Audit Trail: ConsiderKeep loggingtrack updateof operationswhat locallychanges are being made for auditcompliance and rollbacktroubleshooting purposespurposes, as this endpoint modifies device records directly.

Security: Never log or expose API tokens in your application code or logs. Use secure credential storage and rotation practices.

---