templates/documentation/ql.twig line 1

  1. {% extends "base.twig" %}
  2. {% block body %}
  3.     <h3>Quality Label</h3>
  4.     
  5.     <div class="form-row">
  6.       <div class="col-12 mb-3">
  7.         <h4>Endpoint</h4>
  8.         <div>Any call to the module needs to use the base URL {{ app.request.getSchemeAndHttpHost() }}/{{ service }}.</div>
  9.       </div>
  10.     </div>
  12.     <div class="accordion" id="documentation">
  14.       <div class="accordion-item">
  15.         <h2 class="accordion-header" id="header-distributorDetails">
  16.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-distributorDetails" aria-controls="collapse-distributorDetails">/distributor/details</button>
  17.         </h2>
  18.         <div id="collapse-distributorDetails" class="accordion-collapse collapse" aria-labelledby="header-distributorDetails" data-bs-parent="#documentation">
  19.           <ul class="accordion-body list-group p-0">
  20.             <li class="list-group-item d-flex justify-content-between align-items-center">
  21.               Retrieves details on a given distributor.
  22.             </li>
  23.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  24.             <li class="list-group-item d-flex justify-content-between align-items-center">
  25.               distributor: int<br/>
  26.               The internal distributor ID. See /distributor/list.
  27.               <span class="badge bg-danger badge-pill">Required</span>
  28.             </li>
  29.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  30.             <li class="list-group-item d-flex justify-content-between align-items-center">
  31.               id: int<br/>
  32.               The internal distributor ID.
  33.             </li>
  34.             <li class="list-group-item d-flex justify-content-between align-items-center">
  35.               title: string<br/>
  36.               The distributor's name.
  37.             </li>
  38.             <li class="list-group-item d-flex justify-content-between align-items-center">
  39.               street: string<br/>
  40.               The distributor's street address.
  41.             </li>
  42.             <li class="list-group-item d-flex justify-content-between align-items-center">
  43.               zip: string<br/>
  44.               The distributor's zip code.
  45.             </li>
  46.             <li class="list-group-item d-flex justify-content-between align-items-center">
  47.               place: string<br/>
  48.               The distributor's place.
  49.             </li>
  50.             <li class="list-group-item d-flex justify-content-between align-items-center">
  51.               country: string<br/>
  52.               The distributor's country code as defined by ISO 3166-1 alpha-2.
  53.             </li>
  54.             <li class="list-group-item d-flex justify-content-between align-items-center">
  55.               labelCount: int<br/>
  56.               The amount of valid quality labels the distributor holds.
  57.             </li>
  58.           </ul>
  59.         </div>
  60.       </div>
  61.       <div class="accordion-item">
  62.         <h2 class="accordion-header" id="header-distributorList">
  63.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-distributorList" aria-controls="collapse-distributorList">/distributor/list</button>
  64.         </h2>
  65.         <div id="collapse-distributorList" class="accordion-collapse collapse" aria-labelledby="header-distributorList" data-bs-parent="#documentation">
  66.           <ul class="accordion-body list-group p-0">
  67.             <li class="list-group-item d-flex justify-content-between align-items-center">
  68.               Retrieves a list of distributors. The scope is limited to those holding valid labels.
  69.             </li>
  70.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">No arguments.</h4></li>
  71.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  72.               <li class="list-group-item d-flex justify-content-between align-items-center">
  73.                 id: int<br/>
  74.                 The internal distributor ID.
  75.               </li>
  76.               <li class="list-group-item d-flex justify-content-between align-items-center">
  77.               title: string<br/>
  78.               The distributor's name.
  79.             </li>
  80.           </ul>
  81.         </div>
  82.       </div>
  84.       <div class="accordion-item">
  85.         <h2 class="accordion-header" id="header-heatPumpTypeList">
  86.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-heatPumpTypeList" aria-controls="collapse-heatPumpTypeList">/heatPumpType/list</button>
  87.         </h2>
  88.         <div id="collapse-heatPumpTypeList" class="accordion-collapse collapse" aria-labelledby="header-heatPumpTypeList" data-bs-parent="#documentation">
  89.           <ul class="accordion-body list-group p-0">
  90.             <li class="list-group-item d-flex justify-content-between align-items-center">
  91.               Retrieves heat pump types.
  92.             </li>
  93.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">No arguments.</h4></li>
  94.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  95.               <li class="list-group-item d-flex justify-content-between align-items-center">
  96.                 id: int<br/>
  97.                 The internal heat pump type ID.
  98.               </li>
  99.               <li class="list-group-item d-flex justify-content-between align-items-center">
  100.                 title: string<br/>
  101.                 The heat pump type as human-readable string.
  102.               </li>
  103.           </ul>
  104.         </div>
  105.       </div>
  107.       <div class="accordion-item">
  108.         <h2 class="accordion-header" id="header-labelDetails">
  109.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-labelDetails" aria-controls="collapse-labelDetails">/label/details</button>
  110.         </h2>
  111.         <div id="collapse-labelDetails" class="accordion-collapse collapse" aria-labelledby="header-labelDetails" data-bs-parent="#documentation">
  112.           <ul class="accordion-body list-group p-0">
  113.             <li class="list-group-item d-flex justify-content-between align-items-center">
  114.               Retrieves details on a given quality label.
  115.             </li>
  116.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  117.             <li class="list-group-item d-flex justify-content-between align-items-center">
  118.               label: int<br/>
  119.               The internal label ID. See /label/list.
  120.               <span class="badge bg-danger badge-pill">Required</span>
  121.             </li>
  122.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  123.             <li class="list-group-item d-flex justify-content-between align-items-center">
  124.               id: int<br/>
  125.               The internal label ID.
  126.             </li>
  127.             <li class="list-group-item d-flex justify-content-between align-items-center">
  128.               title: string<br/>
  129.               The label title which corresponds to the official label ID formatted as XX-HP-YYYYY.
  130.             </li>
  131.             <li class="list-group-item d-flex justify-content-between align-items-center">
  132.               issueDate: int<br/>
  133.               The label's issue date formatted as UNIX timestamp.
  134.             </li>
  135.             <li class="list-group-item d-flex justify-content-between align-items-center">
  136.               expirationDate: int<br/>
  137.               The label's expiration date formatted as UNIX timestamp.
  138.             </li>
  139.             <li class="list-group-item d-flex justify-content-between align-items-center">
  140.               distributor: int<br/>
  141.               The internal distributor ID. See /distributor/list.
  142.             </li>
  143.             <li class="list-group-item d-flex justify-content-between align-items-center">
  144.               nationalCommission: int<br/>
  145.               The internal national commission ID. See /nationalCommission/list.
  146.             </li>
  147.             <li class="list-group-item d-flex justify-content-between align-items-center">
  148.               id: int<br/>
  149.               The internal heat pump type ID. See /heatPumpType/list.
  150.             </li>
  151.           </ul>
  152.         </div>
  153.       </div>
  154.       <div class="accordion-item">
  155.         <h2 class="accordion-header" id="header-labelList">
  156.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-labelList" aria-controls="collapse-labelList">/label/list</button>
  157.         </h2>
  158.         <div id="collapse-labelList" class="accordion-collapse collapse" aria-labelledby="header-labelList" data-bs-parent="#documentation">
  159.           <ul class="accordion-body list-group p-0">
  160.             <li class="list-group-item d-flex justify-content-between align-items-center">
  161.               Retrieves a list of quality labels. The scope is limited to valid labels.
  162.             </li>
  163.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  164.               <li class="list-group-item d-flex justify-content-between align-items-center">
  165.                 distributor: int<br/>
  166.                 The distributor ID of the labels to be retrieved. See /distributor/list.
  167.                 <span class="badge bg-success badge-pill">Optional</span>
  168.               </li>
  169.             <li class="list-group-item d-flex justify-content-between align-items-center">
  170.                 heatPumpType: int<br/>
  171.                 The heat pump type ID of the labels to be retrieved. See /heatPumpType/list.
  172.                 <span class="badge bg-success badge-pill">Optional</span>
  173.               </li>
  174.               <li class="list-group-item d-flex justify-content-between align-items-center">
  175.                 nationalCommission: int<br/>
  176.                 The national commission ID of the labels to be retrieved. See /nationalCommission/list.
  177.                 <span class="badge bg-success badge-pill">Optional</span>
  178.               </li>
  179.             <li class="list-group-item d-flex justify-content-between align-items-center">
  180.                 searchTerm: string<br/>
  181.                 The search term which is matched against the distributors' title, the labels' titles and the models' titles.
  182.                 <span class="badge bg-success badge-pill">Optional</span>
  183.               </li>
  184.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  185.               <li class="list-group-item d-flex justify-content-between align-items-center">
  186.                 id: int<br/>
  187.                 The internal label ID.
  188.               </li>
  189.               <li class="list-group-item d-flex justify-content-between align-items-center">
  190.                 title: string<br/>
  191.                 The label title which corresponds to the official label ID formatted as XX-HP-YYYYY.
  192.               </li>
  193.               <li class="list-group-item d-flex justify-content-between align-items-center">
  194.                 distributor: int<br/>
  195.                 The internal distributor ID. See /distributor/list.
  196.               </li>
  197.               <li class="list-group-item d-flex justify-content-between align-items-center">
  198.                 nationalCommission: int<br/>
  199.                 The internal national commission ID. See /nationalCommission/list.
  200.               </li>
  201.               <li class="list-group-item d-flex justify-content-between align-items-center">
  202.                 id: int<br/>
  203.                 The internal heat pump type ID. See /heatPumpType/list.
  204.               </li>
  205.             <li class="list-group-item d-flex justify-content-between align-items-center">
  206.               issueDate: int<br/>
  207.               The label's issue date formatted as UNIX timestamp.
  208.             </li>
  209.             <li class="list-group-item d-flex justify-content-between align-items-center">
  210.               expirationDate: int<br/>
  211.               The label's expiration date formatted as UNIX timestamp.
  212.             </li>
  213.           </ul>
  214.         </div>
  215.       </div>
  216.       <div class="accordion-item">
  217.         <h2 class="accordion-header" id="header-labelPdf">
  218.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-labelPdf" aria-controls="collapse-labelPdf">/label/pdf</button>
  219.         </h2>
  220.         <div id="collapse-labelPdf" class="accordion-collapse collapse" aria-labelledby="header-labelPdf" data-bs-parent="#documentation">
  221.           <ul class="accordion-body list-group p-0">
  222.             <li class="list-group-item d-flex justify-content-between align-items-center">
  223.               Retrieves the quality label PDF file.
  224.             </li>
  225.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  226.             <li class="list-group-item d-flex justify-content-between align-items-center">
  227.               label: int<br/>
  228.               The internal label ID. See /label/list.
  229.               <span class="badge bg-danger badge-pill">Required</span>
  230.             </li>
  231.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns a PDF file.</h4></li>
  232.           </ul>
  233.         </div>
  234.       </div>
  236.       <div class="accordion-item">
  237.         <h2 class="accordion-header" id="header-modelDetails">
  238.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-modelDetails" aria-controls="collapse-modelDetails">/model/details</button>
  239.         </h2>
  240.         <div id="collapse-modelDetails" class="accordion-collapse collapse" aria-labelledby="header-modelDetails" data-bs-parent="#documentation">
  241.           <ul class="accordion-body list-group p-0">
  242.             <li class="list-group-item d-flex justify-content-between align-items-center">
  243.               Retrieves details on a given model.
  244.             </li>
  245.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  246.             <li class="list-group-item d-flex justify-content-between align-items-center">
  247.               model: int<br/>
  248.               The internal model ID. See /model/list.
  249.               <span class="badge bg-danger badge-pill">Required</span>
  250.             </li>
  251.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  252.             <li class="list-group-item d-flex justify-content-between align-items-center">
  253.               id: int<br/>
  254.               The internal label ID.
  255.             </li>
  256.             <li class="list-group-item d-flex justify-content-between align-items-center">
  257.               title: string<br/>
  258.               The model title.
  259.             </li>
  260.             <li class="list-group-item d-flex justify-content-between align-items-center">
  261.               label: int<br/>
  262.               The internal ID of the label the model is assigned to. See /label/list.
  263.             </li>
  264.             <li class="list-group-item d-flex justify-content-between align-items-center">
  265.               distributor: int<br/>
  266.               The internal ID of the distributor the model is assigned to. See /distributor/list.
  267.             </li>
  268.             <li class="list-group-item d-flex justify-content-between align-items-center">
  269.               nationalCommission: int<br/>
  270.               The internal ID of the national commission the label is assigned to. See /nationalCommission/list.
  271.             </li>
  272.             <li class="list-group-item d-flex justify-content-between align-items-center">
  273.               heatPumpType: int<br/>
  274.               The internal heat pump type ID. See /heatPumpType/list.
  275.             </li>
  276.           </ul>
  277.         </div>
  278.       </div>
  279.       <div class="accordion-item">
  280.         <h2 class="accordion-header" id="header-modelList">
  281.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-modelList" aria-controls="collapse-modelList">/model/list</button>
  282.         </h2>
  283.         <div id="collapse-modelList" class="accordion-collapse collapse" aria-labelledby="header-modelList" data-bs-parent="#documentation">
  284.           <ul class="accordion-body list-group p-0">
  285.             <li class="list-group-item d-flex justify-content-between align-items-center">
  286.               Retrieves a list of models. The scope is limited to models assigned to valid labels.
  287.             </li>
  288.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  289.               <li class="list-group-item d-flex justify-content-between align-items-center">
  290.                 distributor: int<br/>
  291.                 The distributor ID of the labels to be retrieved. See /distributor/list.
  292.                 <span class="badge bg-success badge-pill">Optional</span>
  293.               </li>
  294.               <li class="list-group-item d-flex justify-content-between align-items-center">
  295.                 heatPumpType: int<br/>
  296.                 The heat pump type ID of the labels to be retrieved. See /heatPumpType/list.
  297.                 <span class="badge bg-success badge-pill">Optional</span>
  298.               </li>
  299.               <li class="list-group-item d-flex justify-content-between align-items-center">
  300.                 nationalCommission: int<br/>
  301.                 The national commission ID of the labels to be retrieved. See /nationalCommission/list.
  302.                 <span class="badge bg-success badge-pill">Optional</span>
  303.               </li>
  304.             <li class="list-group-item d-flex justify-content-between align-items-center">
  305.                 searchTerm: string<br/>
  306.                 The search term which is matched against the distributors' title, the labels' titles and the models' titles.
  307.                 <span class="badge bg-success badge-pill">Optional</span>
  308.               </li>
  309.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  310.               <li class="list-group-item d-flex justify-content-between align-items-center">
  311.                 id: int<br/>
  312.                 The internal label ID.
  313.               </li>
  314.               <li class="list-group-item d-flex justify-content-between align-items-center">
  315.                 title: string<br/>
  316.                 The model title.
  317.               </li>
  318.             <li class="list-group-item d-flex justify-content-between align-items-center">
  319.               label: int<br/>
  320.               The internal ID of the label the model is assigned to. See /label/list.
  321.             </li>
  322.               <li class="list-group-item d-flex justify-content-between align-items-center">
  323.               distributor: int<br/>
  324.               The internal ID of the distributor the label is assigned to. See /distributor/list.
  325.             </li>
  326.             <li class="list-group-item d-flex justify-content-between align-items-center">
  327.               nationalCommission: int<br/>
  328.               The internal ID of the national commission the label is assigned to. See /nationalCommission/list.
  329.             </li>
  330.               <li class="list-group-item d-flex justify-content-between align-items-center">
  331.                 id: int<br/>
  332.                 The internal heat pump type ID. See /heatPumpType/list.
  333.               </li>
  334.           </ul>
  335.         </div>
  336.       </div>
  338.       <div class="accordion-item">
  339.         <h2 class="accordion-header" id="header-nationalCommissionDetails">
  340.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-nationalCommissionDetails" aria-controls="collapse-nationalCommissionDetails">/nationalCommission/details</button>
  341.         </h2>
  342.         <div id="collapse-nationalCommissionDetails" class="accordion-collapse collapse" aria-labelledby="header-nationalCommissionDetails" data-bs-parent="#documentation">
  343.           <ul class="accordion-body list-group p-0">
  344.             <li class="list-group-item d-flex justify-content-between align-items-center">
  345.               Retrieves details on a given national commission.
  346.             </li>
  347.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Arguments:</h4></li>
  348.             <li class="list-group-item d-flex justify-content-between align-items-center">
  349.               nationalCommission: int<br/>
  350.               The internal national commission ID. See /nationalCommission/list.
  351.               <span class="badge bg-danger badge-pill">Required</span>
  352.             </li>
  353.             <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  354.             <li class="list-group-item d-flex justify-content-between align-items-center">
  355.               id: int<br/>
  356.               The internal national commission ID.
  357.             </li>
  358.             <li class="list-group-item d-flex justify-content-between align-items-center">
  359.               title: string<br/>
  360.               The national commission's name.
  361.             </li>
  362.             <li class="list-group-item d-flex justify-content-between align-items-center">
  363.               street: string<br/>
  364.               The national commission's street address.
  365.             </li>
  366.             <li class="list-group-item d-flex justify-content-between align-items-center">
  367.               zip: string<br/>
  368.               The national commission's zip code.
  369.             </li>
  370.             <li class="list-group-item d-flex justify-content-between align-items-center">
  371.               place: string<br/>
  372.               The national commission's place.
  373.             </li>
  374.             <li class="list-group-item d-flex justify-content-between align-items-center">
  375.               country: string<br/>
  376.               The national commission's country code as defined by ISO 3166-1 alpha-2.
  377.             </li>
  378.             <li class="list-group-item d-flex justify-content-between align-items-center">
  379.               labelCount: int<br/>
  380.               The amount of valid quality labels the national commission has issued.
  381.             </li>
  382.           </ul>
  383.         </div>
  384.       </div>
  385.       <div class="accordion-item">
  386.         <h2 class="accordion-header" id="header-nationalCommissionList">
  387.           <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-nationalCommissionList" aria-controls="collapse-nationalCommissionList">/nationalCommission/list</button>
  388.         </h2>
  389.         <div id="collapse-nationalCommissionList" class="accordion-collapse collapse" aria-labelledby="header-nationalCommissionList" data-bs-parent="#documentation">
  390.           <ul class="accordion-body list-group p-0">
  391.             <li class="list-group-item d-flex justify-content-between align-items-center">
  392.               Retrieves a list of national commission. The scope is limited to those having issued currently valid labels.
  393.             </li>
  394.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">No arguments.</h4></li>
  395.               <li class="list-group-item d-flex justify-content-between align-items-center"><h4 class="my-0">Returns JSON data:</h4></li>
  396.               <li class="list-group-item d-flex justify-content-between align-items-center">
  397.                 id: int<br/>
  398.                 The internal national commission ID.
  399.               </li>
  400.               <li class="list-group-item d-flex justify-content-between align-items-center">
  401.               title: string<br/>
  402.               The national commission's name.
  403.             </li>
  404.           </ul>
  405.         </div>
  406.       </div>
  408.     </div>
  409. {% endblock %}