Reporting Code Add — XML Reference

Create a reporting code in the specified category with its description.

Endpoint and formats

POST /api/{companyKey}/reportingcodes/{category}/add

Send Content-Type: application/xml. Select the service host and company key documented in the API Reference. Normal application responses use HTTP 200; inspect summary.result and summary.messages for success or failure.

WCF service and method

Method ReportingCodeAdd

Service contract string ReportingCodeAdd(string category, string reportingCode)

Use the WCF service contract to determine method parameters and message wrapping. The XML examples below describe the business payload. See WCF integration guidance.

XML Request Example

These examples illustrate the XML request and response structure. Use your own company data and the operation’s schema when building requests; promotion results depend on your company configuration.

<reportingcode category="Promotion">
 <code>New Reporting Code</code>
 <description>Promo Reporting Code 1</description>
</reportingcode>

XML Response Example

Example XML response. Actual values depend on the request and configured promotions.

<response>
 <summary result="true">
 <action id="40320">Reporting Code Add</action>
 <messages/>
 <status>Inserted</status>
 </summary>
 <code>New Reporting Code</code>
 <category>Promotion</category>
</response>

Illustrative XML Failure Response

Illustrative failure response (not captured from a live API call). The actual error code and message depend on the failure.

<response><summary result="false"><messages><message code="IM190">A problem was encountered deserializing the request data.</message></messages></summary></response>

XML Schemas (XSD)

• Request XSD — QPSchema_Configuration_ReportingCodeAdd_Request.xsd
• Response XSD — QPSchema_Configuration_ReportingCodeAdd_Response.xsd

These XML Schema Definition (XSD) files define the supported XML request and response structures, including elements, attributes, data types and validation constraints. Use them to validate XML payloads when integrating with the QixolPromo API.

XML Validation Notes

• Preserve the XML root, attributes, nested elements and collection wrappers shown above; JSON-shaped objects are not XML request documents.
• Follow the XSD’s element/attribute distinctions, compositor rules, cardinalities, enumerations and value limits. Examples are complete samples, not exhaustive demonstrations of every optional branch.
• Repeating elements are validated against the XSD; do not flatten a collection into attributes or change item names.
• Validate XML before sending it. For example, download the linked request XSD, save the XML request example as request.xml in the same folder, and run:

xmllint --noout --schema QPSchema_Configuration_ReportingCodeAdd_Request.xsd request.xml

Save the XML response as response.xml alongside the downloaded response XSD, then run:

xmllint --noout --schema QPSchema_Configuration_ReportingCodeAdd_Response.xsd response.xml

Sending XML Requests

To submit an XML request, use the XML Request Example provided above.

Set the HTTP Content-Type header to application/xml and send the XML payload to the appropriate QixolPromo API endpoint.

You can use any HTTP client that supports XML request bodies, such as Postman or cURL.

The corresponding XSD files are available above to help validate your XML requests and responses. For the browser walkthrough and response viewer, see Test an XML request.

Return to API Reference — Reporting Code Add.

API access and security

Services Interaction Keys (API keys) for evaluation companies can be obtained through the QixolPromo Portal; production keys are supplied directly by Qixol. Production API access is IP-restricted by default, unless Qixol disables the restriction. Permitted IP addresses are configured in the Portal under Configuration → Permitted IP Addresses; allowlist changes may take up to 24 hours. Evaluation companies have no IP restrictions. Basket operations use Basket Service Access; other operations use Data Management Service Access. Keep keys confidential.