30 lines
8.1 KiB
HTML
30 lines
8.1 KiB
HTML
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
|
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:40:00.24427986"><title>List vehicles | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"endpoint","level":0,"title":"Endpoint","anchor":"#endpoint"},{"id":"operation","level":0,"title":"Operation","anchor":"#operation"},{"id":"authentication","level":0,"title":"Authentication","anchor":"#authentication"},{"id":"parameters","level":0,"title":"Parameters","anchor":"#parameters"},{"id":"responses","level":0,"title":"Responses","anchor":"#responses"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="List vehicles | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/listvehicles.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="List vehicles | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
|
|
"@context": "http://schema.org",
|
|
"@type": "WebPage",
|
|
"@id": "writerside-documentation/listvehicles.html#webpage",
|
|
"url": "writerside-documentation/listvehicles.html",
|
|
"name": "List vehicles | Copenhagen Truck Wash API",
|
|
"description": "",
|
|
"image": "",
|
|
"inLanguage":"en-US"
|
|
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
|
|
"@type": "WebSite",
|
|
"@id": "writerside-documentation/#website",
|
|
"url": "writerside-documentation/",
|
|
"name": "Copenhagen Truck Wash API Help"
|
|
}</script><!-- End Schema.org --></head><body data-id="listVehicles" data-main-title="List vehicles" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="API-Reference.topic|API Reference///Tag_Vehicles.topic|Vehicles///Tag_Vehicles_Page_1.topic|Vehicles - Page 1 of 1"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="listVehicles" id="listVehicles.topic">List vehicles</h1><p id="c3sjk5_2">This endpoint documentation is generated directly from <code class="code" id="c3sjk5_8">openapi.yaml</code>.</p><section class="chapter"><h2 id="endpoint" data-toc="endpoint">Endpoint</h2><div class="code-block" data-lang="http">GET /vehicles</div></section><section class="chapter"><h2 id="operation" data-toc="operation">Operation</h2><p id="c3sjk5_10">Operation ID: <code class="code" id="c3sjk5_12">listVehicles</code></p><p id="c3sjk5_11">List vehicles or fetch a specific vehicle when `id` is provided. - When `id` is present, returns a single vehicle object (404 if not found). - Otherwise returns a paginated list of vehicles. Permissions: - Own scope: `list_own_vehicles` (linked to subuser node `VEHICLES_LIST`). - Broader scope: `list_vehicles_other`. Subusers may specify header `X-Customer-Number` to target a specific customer. If the broader permission is missing, the list will automatically be restricted to the effective customer context.</p></section><section class="chapter"><h2 id="authentication" data-toc="authentication">Authentication</h2><p id="c3sjk5_13">Security requirements:</p><div class="table-wrapper"><table class="wide" id="c3sjk5_14"><thead><tr class="ijRowHead" id="c3sjk5_15"><th id="c3sjk5_17"><p>Scheme</p></th><th id="c3sjk5_18"><p>Scopes</p></th></tr></thead><tbody><tr id="c3sjk5_16"><td id="c3sjk5_19"><p>BearerAuth</p></td><td id="c3sjk5_20"><p>-</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="parameters" data-toc="parameters">Parameters</h2><div class="table-wrapper"><table class="wide" id="c3sjk5_21"><thead><tr class="ijRowHead" id="c3sjk5_22"><th id="c3sjk5_27"><p>Name</p></th><th id="c3sjk5_28"><p>In</p></th><th id="c3sjk5_29"><p>Required</p></th><th id="c3sjk5_30"><p>Type</p></th><th id="c3sjk5_31"><p>Description</p></th></tr></thead><tbody><tr id="c3sjk5_23"><td id="c3sjk5_32"></td><td id="c3sjk5_33"></td><td id="c3sjk5_34"><p>no</p></td><td id="c3sjk5_35"><p>object</p></td><td id="c3sjk5_36"></td></tr><tr id="c3sjk5_24"><td id="c3sjk5_37"><p>id</p></td><td id="c3sjk5_38"><p>query</p></td><td id="c3sjk5_39"><p>no</p></td><td id="c3sjk5_40"><p>integer</p></td><td id="c3sjk5_41"></td></tr><tr id="c3sjk5_25"><td id="c3sjk5_42"><p>reg</p></td><td id="c3sjk5_43"><p>query</p></td><td id="c3sjk5_44"><p>no</p></td><td id="c3sjk5_45"><p>string</p></td><td id="c3sjk5_46"></td></tr><tr id="c3sjk5_26"><td id="c3sjk5_47"><p>customer_id</p></td><td id="c3sjk5_48"><p>query</p></td><td id="c3sjk5_49"><p>no</p></td><td id="c3sjk5_50"><p>integer</p></td><td id="c3sjk5_51"></td></tr></tbody></table></div></section><section class="chapter"><h2 id="responses" data-toc="responses">Responses</h2><div class="table-wrapper"><table class="wide" id="c3sjk5_52"><thead><tr class="ijRowHead" id="c3sjk5_55"><th id="c3sjk5_59"><p>Status</p></th><th id="c3sjk5_60"><p>Description</p></th><th id="c3sjk5_61"><p>Content Types</p></th></tr></thead><tbody><tr id="c3sjk5_56"><td id="c3sjk5_62"><p>200</p></td><td id="c3sjk5_63"><p>Vehicle(s) retrieved successfully</p></td><td id="c3sjk5_64"><p>application/json</p></td></tr><tr id="c3sjk5_57"><td id="c3sjk5_65"><p>403</p></td><td id="c3sjk5_66"></td><td id="c3sjk5_67"></td></tr><tr id="c3sjk5_58"><td id="c3sjk5_68"><p>404</p></td><td id="c3sjk5_69"></td><td id="c3sjk5_70"></td></tr></tbody></table></div><p id="c3sjk5_53">Schema for response <code class="code" id="c3sjk5_71">200</code> (<code class="code" id="c3sjk5_72">application/json</code>):</p><div class="code-block" data-lang="json">
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Vehicle"
|
|
},
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/Vehicle"
|
|
},
|
|
"type": "array"
|
|
}
|
|
]
|
|
}
|
|
</div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="deletevehicle.html" class="navigation-links__prev">Delete vehicle</a><a href="addvehicle.html" class="navigation-links__next">Add vehicle</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html> |