Add filters doc api

fga-eps-mds · Nov 23, 2018 · 51298a0 · 51298a0
1 parent 5f547d2
commit 51298a0
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/src/comex_stat/templates/homepage.html b/src/comex_stat/templates/homepage.html
@@ -88,28 +88,64 @@ <h2 id="metodosdebusca">3. Métodos de buscas</h2>
       </p>
       <h5>3.1. allImport</h5>
       <p>Buscar por todas as importações</p>
+      <h6>3.1.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
+      <p>No caso do allImport também temos um filtro costumizado chamado <i>"commercializedBetween"</i>, que filtra de acordo com o intervalo de datas. Podemos utilizá-lo no seguinte formato:</p>
+        <div class="card">
+          <div class="card-body">
+            commercializedBetween:"[\"yyyy-mm-dd\",\"yyyy-mm-dd\"]"
+          </div>
+        </div>
+      <p><br />A primeira data é o começo da busca e a segunda o fim da busca, obrigatoriamente no formato ano-mês-dia.</p>
       <h5>3.2. allExport</h5>
       <p>Buscar por todas as expotações</p>
+      <h6>3.2.1 Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
+      <p>No caso do allExport também temos um filtro costumizado chamado <i>"commercializedBetween"</i>, que filtra de acordo com o intervalo de datas. Podemos utilizá-lo no seguinte formato:</p>
+        <div class="card">
+          <div class="card-body">
+            commercializedBetween:"[\"yyyy-mm-dd\",\"yyyy-mm-dd\"]"
+          </div>
+        </div>
+      <p><br />A primeira data é o começo da busca e a segunda o fim da busca, obrigatoriamente no formato ano-mês-dia.</p>
       <h5>3.3. allINcm</h5>
       <p>Buscar por Ncm - Nomenclatura Comum do Mercosul</p>
+      <h6>3.3.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.4. allTradeblocs</h5>
       <p>Buscar por blocos econômicos</p>
+      <h6>3.4.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.5. allCountry</h5>
       <p>Buscar por paises</p>
+      <h6>3.5.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.6. allFederativeunit</h5>
       <p>Buscar por unidade federativa</p>
+      <h6>3.6.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.7. allTransportation</h5>
       <p>Buscar por via(modal) de transporte</p>
+      <h6>3.7.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.8. allUrf</h5>
       <p>Buscar por Urf - Unidade da Receita Federal</p>
+      <h6>3.8.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.9. allCuci</h5>
       <p>
         Buscar por CUCI - Classificação Uniforme para Comércio Internacional
       </p>
+      <h6>3.9.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.10. allCgce</h5>
       <p>Buscar por CGCE - Classificação por Grandes Categorias Econômicas</p>
+      <h6>3.10.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h5>3.11. allSh</h5>
       <p>Buscar SH - Sistema Harmonizado</p>
+      <h6>3.11.1. Filtros disponíveis</h6>
+      <p>Para filtragem, estão disponíveis como parâmetro de consulta todos os campos da model (como por exemplo: "date", "countryNamePt", "ncmCode", "urfName", etc).</p>
       <h2 id="docdinamica">5. Documentação Dinâmica</h2>
       <div class="form-row">
         <div class="form-group col-md-4">