Files
api/documentation/topics/generated/validateCustomerNumber.topic
T

47 lines
1.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Validate customer number" id="validateCustomerNumber">
<!-- AUTO-GENERATED, DO NOT EDIT -->
<p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
<chapter title="Endpoint" id="endpoint">
<code-block lang="http">POST /guest/validation/customer-number</code-block>
</chapter>
<chapter title="Operation" id="operation">
<p>Operation ID: <code>validateCustomerNumber</code></p>
<p>Check if a customer number is valid and exists</p>
</chapter>
<chapter title="Authentication" id="authentication"><p>No authentication required.</p></chapter>
<chapter title="Request Body" id="request-body">
<p>Required: yes.</p>
<p>Content type: <code>application/json</code></p>
<code-block lang="json">
{
&quot;properties&quot;: {
&quot;customer_number&quot;: {
&quot;type&quot;: &quot;integer&quot;
}
},
&quot;required&quot;: [
&quot;customer_number&quot;
],
&quot;type&quot;: &quot;object&quot;
}
</code-block>
</chapter>
<chapter title="Responses" id="responses">
<table>
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
<tr><td>200</td><td>Customer number validation successful</td><td>application/json</td></tr>
<tr><td>400</td><td></td><td></td></tr>
</table>
<p>Schema for response <code>200</code> (<code>application/json</code>):</p>
<code-block lang="json">
{}
</code-block>
</chapter>
</topic>