Equipment Configuration Survey

The Equipment Configuration Survey API allows you to retrieve product-specific survey templates for equipment configuration. Each product has a unique survey consisting of hierarchical questions and available answers that must be completed before placing equipment orders.

Base URLs

Environment	URL
Sandbox	https://boarding-sb.clearent.net/api/
Production	https://boarding.clearent.net/api/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay
MerchantId: Id of the merchant

Available Endpoint:

• Get Survey: GET /api/equipment/surveys/{productKey}

Path Parameters

Name	Data Type	Required?	Description
{productKey}	String	Required	Identifier of the equipment product (survey target)

Additional Information

Usage Workflow:

1. Fetch the latest survey template Always start by calling GET /api/equipment/surveys/{productKey} to retrieve the current survey hierarchy (questions, answer sets, metadata). This ensures your integration uses up‑to‑date templates and avoids breakages if the survey is updated.

2. Populate survey answers The survey is a hierarchical JSON of questions; fill each answer field (initially empty or defaulted) with the correct values for your product configuration.

3. Create the equipment order Once the survey is fully answered, submit it via POST /api/equipment/orders (see the Equipment Order API) to generate an Order ID and place the order.