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

40 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="List public departments" id="listGuestDepartments">
<!-- 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">GET /guest/departments</code-block>
</chapter>
<chapter title="Operation" id="operation">
<p>Operation ID: <code>listGuestDepartments</code></p>
<p>Get list of departments without authentication</p>
</chapter>
<chapter title="Authentication" id="authentication"><p>No authentication required.</p></chapter>
<chapter title="Parameters" id="parameters">
<table>
<tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
<tr><td>include_lanes</td><td>query</td><td>no</td><td>boolean</td><td>Whether to include lane status and self-serve information</td></tr>
</table>
</chapter>
<chapter title="Responses" id="responses">
<table>
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
<tr><td>200</td><td>Departments retrieved successfully</td><td>application/json</td></tr>
</table>
<p>Schema for response <code>200</code> (<code>application/json</code>):</p>
<code-block lang="json">
{
&quot;items&quot;: {
&quot;$ref&quot;: &quot;#/components/schemas/DepartmentGuest&quot;
},
&quot;type&quot;: &quot;array&quot;
}
</code-block>
</chapter>
</topic>