diff --git a/ SMPPIR-API Specification.yaml b/ SMPPIR-API Specification.yaml
deleted file mode 100644
index a79e649100bfa66cc0c7613a45bed5f1430818d8..0000000000000000000000000000000000000000
--- a/ SMPPIR-API Specification.yaml
+++ /dev/null
@@ -1,2973 +0,0 @@
-# Specification of SMPPIR API using OpenAPI 3.0
-# For the specification of OpenAPI 3.0, please refer to: https://swagger.io/docs/specification/about/
-openapi: "3.0.0"
-info:
- version: 1.0.0
- title: SMPPIR - API
- description: 'This API provides access to quotas data based in [INEP - Census of higher education](http://portal.inep.gov.br/web/guest/microdados), [PNAD - People information](http://www.ibge.gov.br/home/estatistica/pesquisas/pesquisa_resultados.php?id_pesquisa=40), [FIES](http://www.fnde.gov.br/dadosabertos/dataset/fundo-de-financiamento-estudantil-fies), [PROUNI](http://dadosabertos.mec.gov.br/prouni)'
-
-servers:
- - url: http://seppirdev.c3sl.ufpr.br:4000/api/v1
-
-tags:
- - name: INEP
- description: "Contains queries made with data from the INEP database listed above. This section's concern is the undergraduation students"
- externalDocs:
- url: http://portal.inep.gov.br/web/guest/microdados
- - name: FIES
- description: "Contains queries made with data from the FIES database listed above. This section's concern is the loan for undergraduation students"
- externalDocs:
- url: http://www.fnde.gov.br/dadosabertos/dataset/fundo-de-financiamento-estudantil-fies
- - name: PNAD
- description: "Contains queries made with data from the PNAD database listed above. This section's concern is the educational level of the population between 18 and 24 years old"
- externalDocs:
- url: http://www.ibge.gov.br/home/estatistica/pesquisas/pesquisa_resultados.php?id_pesquisa=40
- - name: PROUNI
- description: "Contains queries made with data from the PROUNI database listed above. This section's concern is the federal scholarship"
- externalDocs:
- url: http://www.ibge.gov.br/home/estatistica/pesquisas/pesquisa_resultados.php?id_pesquisa=40
-# - name: IBGE - Census
-# description: "Contains queries made with data from IBGE Census"
-# externalDocs:
-#url: https://ww2.ibge.gov.br/home/estatistica/populacao/censo2010/resultados_gerais_amostra/resultados_gerais_amostra_tab_uf_microdados.shtm
- - name: CadÚnico
- description: "Contains queries made with data from CadÚnico"
- externalDocs:
- url: https://aplicacoes.mds.gov.br/sagi/portal/index.php?grupo=212
- - name: EXTRA
- description: "Contains data from auxiliary extra routes"
- externalDocs:
- url: https://ww2.ibge.gov.br/home/estatistica/populacao/censo2010/resultados_gerais_amostra/resultados_gerais_amostra_tab_uf_microdados.shtm
-
-paths:
- /admission:
- get:
- summary: Return the number of quotasholder that entered in a federal institution. This route uses the INEP database listed above
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - shift
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - year
- - min_year
- - max_year
- - cod_offer_location
- - name_offer_location
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BasicInepReturn'
- '404':
- description: no data found
- /evader:
- get:
- summary: Return the number of quotasholder that had been studying in a federal institution and drop out. This route uses the INEP database listed above
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - shift
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - year
- - min_year
- - max_year
- - cod_offer_location
- - name_offer_location
- - region
- - uf
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
- region:
- type: array
- items:
- type: string
- uf:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BasicInepReturnWithLocationInfo'
- '404':
- description: no data found
- /extracurricular_activities:
- get:
- summary: Return the number of quotasholder that studie in a federal institution and do any type of extracurricular activity (Intership, Teacher's Assistant, etc.). This route uses the INEP database listed above
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - shift
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - year
- - min_year
- - max_year
- - cod_offer_location
- - name_offer_location
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BasicInepReturn'
- '404':
- description: no data found
- /fies:
- get:
- summary: Return the number of students that got a loan from FIES. This route uses the FIES database listed above
- tags:
- - FIES
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - offer_location
- - loan
- - loan_type
- - uf
- - region
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: gender:"Feminino",ethnic:["Branco","Pardo"]
- schema:
- type: array
- items:
- type: object
- properties:
- gender:
- type: array
- items:
- type: string
- enum: ['Masculino', 'Feminino']
- ethnic:
- type: array
- items:
- type: string
- enum: ['Amarelo', 'Branco', 'Negro', 'Pardo', 'Índio']
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_cod:
- type: array
- items:
- type: integer
- offer_location:
- type: array
- items:
- type: string
- loan:
- type: array
- items:
- type: integer
- enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100 ]
- loan_type:
- type: array
- items:
- type: string
- enum: ["F", "N", "S"]
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- region:
- type: array
- items:
- type: string
- enum: [ 'Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste' ]
- uf:
- type: array
- items:
- type: string
- enum: [ 'AC', 'AL', 'AP', 'AM', 'BA', 'CE', 'DF', 'ES', 'GO', 'MA', 'MT', 'MS', 'MG', 'PA', 'PB', 'PR', 'PE', 'PI', 'RJ', 'RN', 'RS', 'RO', 'RR', 'SC', 'SP', 'SE', 'TO' ]
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FiesReturn'
- '404':
- description: no data found
- /graduate:
- get:
- summary: Return the number of quotasholder that had been studying in a federal institution and finished their studies
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - shift
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - year
- - min_year
- - max_year
- - cod_offer_location
- - name_offer_location
- - region
- - uf
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
- region:
- type: array
- items:
- type: string
- uf:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BasicInepReturnWithLocationInfo'
- '404':
- description: no data found
-
- /course:
- get:
- summary: Return the available courses made available by the IFES(Instituto Federal de Educação Superior). This route uses the INEP database listed above
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - uf
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015", uf:"PR"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
- uf:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/course'
- '404':
- description: no data found
-
- /courseFIES:
- get:
- summary: Return the available courses made available by the IFES(Instituto Federal de Educação Superior). This route uses the FIES database listed above
- tags:
- - FIES
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/coursePROUNI'
- '404':
- description: no data found
-
- /coursePROUNI:
- get:
- summary: Return the available courses made available by the IFES(Instituto Federal de Educação Superior). This route uses the PROUNI database listed above
- tags:
- - PROUNI
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/courseFIES'
- '404':
- description: no data found
-
- /institution:
- get:
- summary: Return the exiting IFES(Instituto Federal de Educação Superior) that are public. This route uses the INEP database listed above
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - uf
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015", uf:"PR"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
- uf:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/institution'
- '404':
- description: no data found
-
- /institutionFIES:
- get:
- summary: Return the exiting IFES(Instituto Federal de Educação Superior) that are public. This route uses the FIES database listed above
- tags:
- - FIES
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/institutionFIES'
- '404':
- description: no data found
-
- /institutionPROUNI:
- get:
- summary: Return the exiting IFES(Instituto Federal de Educação Superior) that are public. This route uses the PROUNI database listed above
- tags:
- - PROUNI
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/institutionPROUNI'
- '404':
- description: no data found
-
- /ibge_code:
- get:
- summary: Return the name and code of a city as well as the code for the state the city is in. This route uses the IBGE database listed above.
- tags:
- - EXTRA
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - city_name
- - city_code
- - state
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: city_name:"Curitiba", state:"17"
- schema:
- type: array
- items:
- type: object
- properties:
- city_name:
- type: string
- city_code:
- type: number
- state:
- type: number
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ibge_code'
- '404':
- description: no data found
-
- /institutionPrivate:
- get:
- summary: Return the existing IFES(Instituto Federal de Educação Superior) that are private. This route uses the INEP database listed above
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,uf
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2015"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: number
- min_year:
- type: number
- max_year:
- type: number
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/institutionPrivate'
- '404':
- description: no data found
-
- /vacancy:
- get:
- summary: Return the number of quotasholder spots that are open to students in a federal institution
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - region
- - uf
- - cod_ies
- - campus
- - course
- - shift
- - name_ies
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
- region:
- type: array
- items:
- type: string
- uf:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/vacancy'
- '404':
- description: no data found
-
- /pnad:
- get:
- summary: Return the number of people obtained by IBGE in the PNAD research. This route uses the PNAD database listed above
- tags:
- - PNAD
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: level_of_education,type_of_school
- schema:
- type: array
- items:
- type: string
- enum:
- - ethnic
- - type_of_school
- - type_of_public_school
- - level_of_education
- - uf
- - region
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: level_of_education:["2","6"],type_of_school:"4"
- schema:
- type: array
- items:
- type: object
- properties:
- ethnic:
- type: "array"
- items:
- type: "string"
- enum: ['0', '2', '4', '6', '8', '9']
- type_of_school:
- type: "array"
- items:
- type: "string"
- enum: ['2', '4']
- type_of_public_school:
- type: "array"
- items:
- type: "string"
- enum: ['2','4','6']
- level_of_education:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','5','6','10','11']
- uf:
- type: "array"
- items:
- type: "string"
- enum: ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
- region:
- type: "array"
- items:
- type: "string"
- enum: ['Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste']
- year:
- type: "array"
- items:
- type: "integer"
- min_year:
- type: "integer"
- max_year:
- type: "integer"
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PnadReturn'
- '404':
- description: no data found
- /prouni:
- get:
- summary: Return the number of people that received a scholarship from PROUNI. This route uses the PROUNI database listed above
- tags:
- - PROUNI
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender
- schema:
- type: array
- items:
- type: string
- enum:
- - shift
- - gender
- - ethnic
- - course
- - institution
- - scholarship
- - uf
- - region
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Curso a distância"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: "string"
- enum: ["Curso a distância", "Integral", "Matutino", "Noturno", "Vespertino"]
- gender:
- type: "string"
- enum: ["Masculino", "Feminino"]
- ethnic:
- type: "string"
- enum: ["Amarela", "Branca", "Indígena", "Não Informada", "Parda", "Preta"]
- course:
- type: "string"
- institution:
- type: "string"
- scholarship:
- type: "string"
- enum: ["BOLSA INTEGRAL", "BOLSA PARCIAL 50%"]
- uf:
- type: "array"
- items:
- type: "string"
- enum: ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
- region:
- type: "array"
- items:
- type: "string"
- enum: ['Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste']
- year:
- type: "array"
- items:
- type: "integer"
- min_year:
- type: "integer"
- max_year:
- type: "integer"
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ProuniReturn'
- '404':
- description: no data found
- /social_support:
- get:
- summary: Return the number of quotasholder that had been studying in a federal institution and had some sort of social support
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - shift
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - food_support
- - support
- - work_support
- - courseware_support
- - housing_support
- - transport_support
- - year
- - min_year
- - max_year
- - cod_offer_location
- - name_offer_location
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- food_support:
- type: array
- items:
- type: string
- support:
- type: array
- items:
- type: string
- work_support:
- type: array
- items:
- type: string
- courseware_support:
- type: array
- items:
- type: string
- housing_support:
- type: array
- items:
- type: string
- transport_support:
- type: array
- items:
- type: string
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SocialSupportReturn'
- '404':
- description: no data found
- /student_loans:
- get:
- summary: Return the number of quotasholder that had been studying in a federal institution and contracted some sort of loan
- tags:
- - INEP
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift,gender,ethnic
- schema:
- type: array
- items:
- type: string
- enum:
- - cod_offer_location
- - name_offer_location
- - shift
- - gender
- - ethnic
- - course
- - institution
- - institution_cod
- - refund_fies
- - refund_state
- - refund_city
- - refund_edu_inst
- - refund_org
- - refund_others
- - no_refund_prouni_integral
- - no_refund_prouni_partial
- - no_refund_state
- - no_refund_city
- - no_refund_edu_inst
- - no_refund_org
- - no_refund_others
- - year
- - min_year
- - max_year
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: shift:["Integral","Noturno"],gender:"Feminino"
- schema:
- type: array
- items:
- type: object
- properties:
- shift:
- type: array
- items:
- type: string
- gender:
- type: array
- items:
- type: string
- ethnic:
- type: array
- items:
- type: string
- course:
- type: array
- items:
- type: string
- institution:
- type: array
- items:
- type: string
- institution_code:
- type: array
- items:
- type: integer
- refund_fies:
- type: array
- items:
- type: string
- refund_state:
- type: array
- items:
- type: string
- refund_city:
- type: array
- items:
- type: string
- refund_edu_inst:
- type: array
- items:
- type: string
- refund_org:
- type: array
- items:
- type: string
- refund_others:
- type: array
- items:
- type: string
- no_refund_prouni_integral:
- type: array
- items:
- type: string
- no_refund_prouni_partial:
- type: array
- items:
- type: string
- no_refund_state:
- type: array
- items:
- type: string
- no_refund_city:
- type: array
- items:
- type: string
- no_refund_edu_inst:
- type: array
- items:
- type: string
- no_refund_org:
- type: array
- items:
- type: string
- no_refund_others:
- type: array
- items:
- type: string
- year:
- type: array
- items:
- type: integer
- min_year:
- type: integer
- max_year:
- type: integer
- cod_offer_location:
- type: array
- items:
- type: integer
- name_offer_location:
- type: array
- items:
- type: string
- region:
- type: array
- items:
- type: string
- uf:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/InepLoanReturn'
- '404':
- description: no data found
-
-# /ibge_census:
-# get:
-# summary: Return the number of people obtained by IBGE in the last census. This route uses the IBGE data listed above
-# tags:
-# - IBGE - Census
-# parameters:
-# - name: dims
-# in: query
-# description: Group data using a metric parameter
-# allowReserved: true
-# required: false
-# explode: false
-# style: form
-# example: ethnic,gender
-# schema:
-# type: array
-# items:
-# type: string
-# enum:
-# - ethnic
-# - gender
-# - religion
-# - income_range
-# - age
-# - age_greater_than
-# - age_lesser_than
-# - highest_education
-# - school_daycare
-# - work_status
-# - education_level
-# - ocupation_position_and_category
-# - home_status
-# - work_condition
-# - mensal_home_income_range
-# - relation_homeowner
-# - name: filter
-# in: query
-# description: Filter data
-# allowReserved: true
-# required: false
-# explode: false
-# style: form
-# example: ethnic:["2","6"],gender:"1"
-# schema:
-# type: array
-# items:
-# type: object
-# properties:
-# ethnic:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2', '3', '4', '5', '9']
-# gender:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2']
-# religion:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['0', '1', '2', '110', '111', '112', '120', '130', '140', '149', '199', '210', '219', '220', '221', '222', '223', '224', '225', '229', '230', '231', '232', '239', '240', '241', '242', '243', '244', '245', '249', '250', '251', '259', '260', '261', '262', '269', '270', '279', '280', '289', '300', '310', '311', '312', '319', '320', '329', '330', '339', '340', '349', '350', '359', '360', '369', '370', '379', '380', '389', '390', '399', '400', '401', '409', '420', '429', '430', '439', '440', '449', '450', '451', '452', '453', '454', '455', '460', '469', '470', '479', '480', '489', '490', '492', '499', '510', '519', '520', '529', '530', '590', '599', '610', '619', '620', '629', '630', '639', '640', '641', '649', '710', '711', '719', '740', '741', '749', '750', '751', '752', '753', '754', '755', '759', '760', '761', '762', '763', '764', '765', '766', '790', '791', '792', '793', '799', '810', '811', '819', '820', '821', '829', '830', '831', '832', '834', '839', '850', '890', '891', '892', '893', '894', '895', '896', '990', '999', ]
-# income_range:
-# type: "array"
-# items:
-# type: "number"
-# age:
-# type: "array"
-# items:
-# type: "integer"
-# age_greater_than:
-# type: "array"
-# items:
-# type: "integer"
-# age_lesser_than:
-# type: "array"
-# items:
-# type: "integer"
-# highest_education:
-# type: "array"
-# items:
-# type: "string"
-# enum: [null, '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14']
-# school_daycare:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2','3', '4']
-# work_status:
-# type: "array"
-# items:
-# type: "string"
-# enum: [null, '1', '2']
-# education_level:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2', '3', '4', '5']
-# ocupation_position_and_category:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2']
-# home_status:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2']
-# work_condition:
-# type: "array"
-# items:
-# type: "string"
-# enum: [null, '1', '2']
-# mensal_home_income_range:
-# type: "array"
-# items:
-# type: "number"
-# relation_homeowner:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20']
-#
-# responses:
-# '200':
-# description: successful operation
-# content:
-# application/json:
-# schema:
-# $ref: '#/components/schemas/IBGECensusReturn'
-# '404':
-# description: no data found
-
-# /cad_unico:
-# get:
-# summary: Return the number of people and families from that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
-# tags:
-# - CadÚnico
-# parameters:
-# - name: dims
-# in: query
-# description: Group data using a metric parameter
-# allowReserved: true
-# required: false
-# explode: false
-# style: form
-# example: year,home_type
-# schema:
-# type: array
-# items:
-# type: string
-# enum:
-# - year
-# - per_capita_income
-# - home_type
-# - home_location
-# - education_families
-# - education_families_level
-# - education_families_conclude
-# - name: filter
-# in: query
-# description: Filter data
-# allowReserved: true
-# required: false
-# explode: false
-# style: form
-# example: ethnic:["2","6"],gender:"1"
-# schema:
-# type: array
-# items:
-# type: object
-# properties:
-# year:
-# type: "array"
-# items:
-# type: "string"
-# enum: ['2012', '2013', '2014', '2015', '2016']
-# per_capita_income:
-# type: "array"
-# items:
-# type: "string"
-# home_type:
-# type: "array"
-# items:
-# type: "string"
-# enum: [null, '1','2','3']
-# home_location:
-# type: 'array'
-# items:
-# type: "number"
-# education_families_conclude:
-# type: "array"
-# items:
-# type: "string"
-# enum: [null, '1', '2']
-# education_families:
-# type: 'array'
-# items:
-# type: "string"
-# enum: [null, '1','2','3','4','5','6','7','8','9','10','11','12','13','14','15']
-# education_families_level:
-# type: 'array'
-# items:
-# type: "string"
-# enum: [null,'1','2','3','4','5','6','7','8','9','10']
-
-# responses:
-# '200':
-# description: successful operation
-# content:
-# application/json:
-# schema:
-# $ref: '#/components/schemas/CadUnicoReturn'
-# '404':
-# description: no data found
-
- /african_culture:
- get:
- summary: Return the type of house and location of the houses that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - cod_local_home
- - home_type
- - home_location
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
- cod_local_home:
- type: "array"
- items:
- type: "string"
- enum: ['1','2']
- home_type:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3']
- home_location:
- type: "array"
- items:
- type: "string"
- enum: ['1301902','1303809', '1304237','1500107','1502806','1503705','1503903','1504604','1504901','1505205']
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AfricanCulture'
- '404':
- description: no data found
-
- /african_rights:
- get:
- summary: Return the education level and number of families that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - education_families_conclude
- - education_families_level
- - education_families
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
- education_families_conclude:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','null']
- education_families_level:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','5','6','7','8','9','null']
- education_families:
- type: "array"
- items:
- type: "string"
- enum: ['3','4','5','6','7','8','9','12','13','null']
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AfricanRights'
- '404':
- description: no data found
-
- /african_sustentability:
- get:
- summary: Return the average per capita income from families that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - family_type
- - per_capita_income
-
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
- vlr_renda_media_fam:
- type: "array"
- items:
- type: "number"
- minimum: 0
- maximum: 3000
-
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AfricanSustentability'
- '404':
- description: no data found
-
- /eixo_2:
- get:
- summary: Return the infraestructure and life quality information about quilombola families obtained by CadÚnico. This route uses the CadUnico data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - family_type
- - cod_local_home
- - cod_home_lighting
- - cod_home_trash_destiny
- - cod_home_watter_supply
- - cod_sanitary_dump
- - home_type
- - home_location
- - uf
- - region
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
- family_type:
- type: "array"
- items:
- type: "string"
- enum: ['201','202','203','204','205','301','302','303','304','305','306','101','0','null']
- cod_local_home:
- type: "array"
- items:
- type: "string"
- enum: ['1','2,','NA','null']
- cod_home_lighting:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','5','6','NA','null']
- cod_home_trash_destiny:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','5','6','null','NA']
- cod_home_watter_supply:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','null','NA']
- home_type:
- type: "array"
- items:
- type: "string"
- enum: ['1', '2', '3', 'null']
- uf:
- type: "array"
- items:
- type: "string"
- enum: ['RS', 'BA', 'PA', 'PR', 'GO', 'MA', 'AL','SE', 'MG', 'PE', 'PI','RN', 'ES', 'PB', 'CE', 'SP', 'SC', 'MS', 'MT', 'AM', 'AP', 'RO', 'TO', 'RJ', 'AC','DF','RR']
- region:
- type: "array"
- items:
- type: "string"
- enum: ['norte','nordeste','sul','centro-oeste','sudeste']
- cod_escoa_sanitario_domic_fam:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','5','6','null','NA']
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Eixo2'
- '404':
- description: no data found
-
- /eixo_3:
- get:
- summary: Return the local development and productive inclusion about quilombola families obtained by CadÚnico. This route uses the CadUnico data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - family_type
- - cod_home_bolsa_familia
- - cod_agriculture_job
- - per_capita_income
- - home_location
- - uf
- - region
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
- family_type:
- type: "array"
- items:
- type: "string"
- enum: ['201','202','203','204','205','301','302','303','304','305','306','101','0','null']
- cod_home_bolsa_familia:
- type: "array"
- items:
- type: "string"
- enum: ['0','1','null']
- cod_agriculture_job:
- type: "array"
- items:
- type: "string"
- enum: ['0','1','null','NA']
- per_capita_income:
- type: "array"
- items:
- type: "string"
- minimum: 0
- maximum: 2800
- home_location:
- type: "array"
- items:
- type: "string"
- minimum: 1100015
- maximum: 5300108
- uf:
- type: "array"
- items:
- type: "string"
- enum: ['RS', 'BA', 'PA', 'PR', 'GO', 'MA', 'AL','SE', 'MG', 'PE', 'PI','RN', 'ES', 'PB', 'CE', 'SP', 'SC', 'MS', 'MT', 'AM', 'AP', 'RO', 'TO', 'RJ', 'AC','DF','RR']
- region:
- type: "array"
- items:
- type: "string"
- enum: ['norte','nordeste','sul','centro-oeste','sudeste']
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Eixo3'
- '404':
- description: no data found
-
- /eixo_4:
- get:
- summary: Return the rights and citizenship information about quilombola families obtained by CadÚnico. This route uses the CadUnico data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - cod_local_home
- - age
- - education_families_conclude
- - education_families_level
- - education_families
- - uf
- - region
- - gender
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
- age:
- type: "array"
- items:
- type: "string"
- minimum: 0
- maximum: 128
- education_families_conclude:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','null']
- education_families_level:
- type: "array"
- items:
- type: "string"
- enum: ['1','1','3','4','5','6','7','8','9','10']
- education_families:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','3','4','5','6','7','8','9','10','11','12','13','14','15','null']
- uf:
- type: "array"
- items:
- type: "string"
- enum: ['RS', 'BA', 'PA', 'PR', 'GO', 'MA', 'AL','SE', 'MG', 'PE', 'PI','RN', 'ES', 'PB', 'CE', 'SP', 'SC', 'MS', 'MT', 'AM', 'AP', 'RO', 'TO', 'RJ', 'AC','DF','RR']
- region:
- type: "array"
- items:
- type: "string"
- enum: ['norte','nordeste','sul','centro-oeste','sudeste']
- gender:
- type: "array"
- items:
- type: "string"
- enum: ['1','2','null']
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Eixo4'
- '404':
- description: no data found
-
- /quilombola_metrics:
- get:
- summary: Return the useful metrics for quilombola families obtained by CadÚnico, like the maximum, minimum and average income they have, per year. This route uses the CadUnico data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
-
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year:"2016"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016','2017']
-
-
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/metrics'
- '404':
- description: no data found
-
-components:
- schemas:
-
- Eixo2:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in quilombola_eixo_2 queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- ind_parc_mds_fam:
- type: "number"
- cod_local_domic_fam:
- type: "number"
- cod_iluminacao_domic_fam:
- type: "number"
- cod_destino_lixo_domic_fam:
- type: "number"
- cod_abaste_agua_domic_fam:
- type: "number"
- cod_especie_domic_fam:
- type: "number"
- uf:
- type: "string"
- region:
- type: "string"
- cod_escoa_sanitario_domic_fam:
- type: "number"
- Eixo3:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in quilombola_eixo_3 queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- ind_parc_mds_fam:
- type: "number"
- marc_pbf:
- type: "number"
- ind_familia_quilombola_fam:
- type: "number"
- cod_agricultura_trab_memb:
- type: "number"
- vlr_renda_media_fam:
- type: "number"
- cd_ibge:
- type: "number"
- uf:
- type: "string"
- region:
- type: "string"
- cod_escoa_sanitario_domic_fam:
- type: "number"
-
- Eixo4:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in quilombola_eixo_3 queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- idade:
- type: "number"
- cod_concluiu_frequentou_memb:
- type: "string"
- cod_ano_serie_frequentou_memb:
- type: "string"
- cod_curso_frequentou_pessoa_memb:
- type: "string"
- uf:
- type: "string"
- region:
- type: "string"
- genero:
- type: "string"
-
- metrics:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in quilombola_metrics queries
- properties:
- ano_pesquisa:
- type: "number"
-
- AfricanSustentability:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in african_rights queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- vlr_renda_media_fam:
- type: "number"
-
-
- AfricanRights:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in african_rights queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- cod_concluiu_frequentou_memb:
- type: "string"
- cod_ano_serie_frequentou_memb:
- type: "string"
- cod_curso_frequentou_pessoa_memb:
- type: "string"
-
- AfricanCulture:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in african_culture queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- cod_local_domic_fam:
- type: "string"
- cod_especie_domic_fam:
- type: "string"
- cd_ibge:
- type: "string"
-
-# CadUnicoReturn:
-# type: object
-# required: ['total']
-# description: |
-# This model represents the return possibilities in CadUnico queries
-# properties:
-# total:
-# type: "number"
-# ano_pesquisa:
-# type: "number"
-# vlr_renda_media_fam:
-# type: "number"
-# cod_especie_domic_fam:
-# type: "string"
-# cd_ibge:
-# type: "string"
-# cod_concluiu_frequentou_memb:
-# type: "string"
-# cod_ano_serie_frequentou_memb:
-# type: "string"
-# cod_curso_frequentou_pessoa_memb:
-# type: "string"
-
- course:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in course queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
- uf:
- type: "string"
- courseFIES:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in courseFIES queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
- uf:
- type: "string"
- coursePROUNI:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in course queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
- uf:
- type: "string"
- institution:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in institution queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
- uf:
- type: "string"
-
- institutionFIES:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in institutionFIES queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
-
- institutionPROUNI:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in institutionPROUNI queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
-
-
- institutionPrivate:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in institution queries
- properties:
- total:
- type: "number"
- year:
- type: "number"
- uf:
- type: "string"
-
- ibge_code:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in ibge_code queries
- properties:
- no_cidade:
- type: "string"
- co_cidade:
- type: "number"
- sgl_estado:
- type: "string"
-
-# IBGECensusReturn:
-# type: object
-# required: ['total']
-# description: |
-# This model represents the return possibilities in IBGE Census queries
-# properties:
-# total:
-# type: "number"
-# co_cor_raca:
-# type: "string"
-## co_sexo:
-# type: "string"
-# co_religiao:
-# type: "string"
-# nu_sal_min_todos_trabalhos:
-# type: "number"
-# nu_idade_calculada_anos:
-# type: "number"
-# co_curso_mais_elevado_freq:
-# type: "string"
- # co_freq_escola_creche:
-# type: "string"
-# co_condicao_atividade_semana_ref:
-# type: "string"
-# co_nivel_instrucao:
-# type: "string"
-# co_posicao_na_ocupacao_e_categoria_do_emprego:
-# type: "string"
-# co_situacao_dom:
-# type: "string"
-# co_condicao_ocupacao_semana_ref:
-# type: "string"
-# vl_rendimneto_mensal_domicilio_sal_min_per_capita:
-# type: "number"
-# co_relacao_responsavel_dom:
-# type: "string"
-
- BasicInepReturn:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in INEP queries when location information is not needed.
- Note that there will always exists the total and no_ano_pesquisa keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'no_ano_pesquisa']
- properties:
- total:
- type: "number"
- no_ano_pesquisa:
- type: "integer"
- format: "int32"
- ds_turno_aluno:
- type: "string"
- enum: ['Integral', 'Matutino', 'Noturno', 'Não aplicável', 'Vespertino']
- ds_sexo_aluno:
- type: "string"
- enum: ['Masculino', 'Feminino']
- ds_cor_raca_aluno:
- type: "string"
- enum: ['Aluno não quis declarar cor/raça', 'Amarela', 'Branca', 'Indígena', 'Parda', 'Preta']
- no_curso:
- type: "string"
- no_ies:
- type: "string"
- co_ies:
- type: "integer"
- co_local_oferta:
- type: "integer"
- no_local_oferta:
- type: "string"
- BasicInepReturnWithLocationInfo:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in INEP queries when location information is needed.
- Note that there will always exists the total and no_ano_pesquisa keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'no_ano_pesquisa']
- properties:
- total:
- type: "number"
- no_ano_pesquisa:
- type: "integer"
- format: "int32"
- ds_turno_aluno:
- type: "string"
- enum: ['Integral', 'Matutino', 'Noturno', 'Não aplicável', 'Vespertino']
- ds_sexo_aluno:
- type: "string"
- enum: ['Masculino', 'Feminino']
- ds_cor_raca_aluno:
- type: "string"
- enum: ['Aluno não quis declarar cor/raça', 'Amarela', 'Branca', 'Indígena', 'Parda', 'Preta']
- no_curso:
- type: "string"
- no_ies:
- type: "string"
- co_ies:
- type: "integer"
- co_local_oferta:
- type: "integer"
- no_local_oferta:
- type: "string"
- region:
- type: "string"
- enum: ['Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste']
- uf:
- type: "string"
- enum: ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
-
- vacancy:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in vacancy queries
- properties:
- total:
- type: "number"
- uf:
- type: "string"
- region:
- type: "string"
- year:
- type: "number"
- cod_ies:
- type: "integer"
- campus:
- type: "string"
- curso:
- type: "string"
- turno:
- type: "string"
- nome_ies:
- type: "string"
- cod_especie_domic_fam:
- type: "number"
- total_vagas_ampla_concorrencia_nao_pcd:
- type: "number"
- total_vagas_ampla_concorrencia_pcd:
- type: "number"
- total_vagas_cotas_renda_baixa_ppi_nao_pcd:
- type: "number"
- total_vagas_cotas_renda_baixa_ppi_pcd:
- type: "number"
- total_vagas_cotas_renda_baixa_outros_nao_pcd:
- type: "number"
- total_vagas_cotas_renda_baixa_outros_pcd:
- type: "number"
- total_vagas_cotas_renda_alta_ppi_nao_pcd:
- type: "number"
- total_vagas_cotas_renda_alta_ppi_pcd:
- type: "number"
- total_vagas_cotas_renda_alta_outros_nao_pcd:
- type: "number"
- total_vagas_cotas_renda_alta_outros_pcd:
- type: "number"
- total_total_pcd:
- type: "number"
-
-
-
- FiesReturn:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in FIES queries.
- Note that there will always exists the total and nu_ano keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'nu_ano']
- properties:
- total:
- type: "number"
- nu_ano:
- type: "integer"
- format: "int32"
- ds_sexo:
- type: "string"
- enum: ['Masculino', 'Feminino']
- ds_raca_cor:
- type: "string"
- enum: ['Amarelo','Branco','Negro','Pardo','Índio']
- ds_curso:
- type: "string"
- no_ies:
- type: "string"
- co_ies:
- type: "integer"
- no_campus:
- type: "string"
- nu_percent_solicitado_financ:
- type: integer
- enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100 ]
- tp_fianca:
- type: "string"
- enum: ["F", "N", "S"]
- description: |
- Meanings of each letter:
-
- F - Fundo de Garantia de Operações de Crédito Educativo – FGEDUC
-
- N - Normal/Convencional
-
- S - Solidária
- region:
- type: "string"
- enum: ['Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste']
- uf:
- type: "string"
- enum: ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
- PnadReturn:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in PNAD queries.
- Note that there will always exists the total and nu_ano_referencia keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'nu_ano_referencia']
- properties:
- total:
- type: "number"
- nu_ano_referencia:
- type: "integer"
- format: "int32"
- co_cor_raca:
- type: "string"
- enum: ['0', '2', '4', '6', '8', '9']
- co_rede_ensino:
- type: "string"
- enum: ['2', '4']
- co_area_rede_publica_ensino:
- type: "string"
- enum: ['2','4','6']
- co_curso:
- type: "string"
- enum: ['1','2','3','4','5','6','10','11']
- uf:
- type: "string"
- enum: ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
- region:
- type: "string"
- enum: ['Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste']
- ProuniReturn:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in PROUNI queries.
- Note that there will always exists the total and ano_concessao_bolsa keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'ano_concessao_bolsa']
- properties:
- total:
- type: "number"
- ano_concessao_bolsa:
- type: "integer"
- format: "int32"
- nome_turno_curso_bolsa:
- # shift
- type: "string"
- enum: ['Curso a distância', 'Integral', 'Matutino', 'Noturno', 'Vespertino']
- sexo_beneficiario_bolsa:
- # gender
- type: "string"
- enum: ["Masculino", "Feminino"]
- raca_beneficiario_bolsa:
- # ethnic
- type: "string"
- enum: ['Amarela', 'Branca', 'Indígena', 'Não Informada', 'Parda', 'Preta']
- nome_curso_bolsa:
- # course
- type: "string"
- nome_ies_bolsa:
- # institution
- type: "string"
- tipo_bolsa:
- # scholarship
- type: "string"
- enum: ["BOLSA INTEGRAL", "BOLSA PARCIAL 50%"]
- sigla_uf_beneficiario_bolsa:
- # uf
- type: "string"
- enum: ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
- regiao_beneficiario_bolsa:
- # region
- type: "string"
- enum: ['Norte', 'Nordeste', 'Centro-Oeste', 'Sul', 'Sudeste']
- SocialSupportReturn:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in INEP queries when location information is not needed.
- Note that there will always exists the total and no_ano_pesquisa keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'no_ano_pesquisa']
- properties:
- total:
- type: "number"
- no_ano_pesquisa:
- type: "integer"
- format: "int32"
- ds_turno_aluno:
- type: "string"
- enum: ['Integral', 'Matutino', 'Noturno', 'Não aplicável', 'Vespertino']
- ds_sexo_aluno:
- type: "string"
- enum: ['Masculino', 'Feminino']
- ds_cor_raca_aluno:
- type: "string"
- enum: ['Aluno não quis declarar cor/raça', 'Amarela', 'Branca', 'Indígena', 'Parda', 'Preta']
- no_curso:
- type: "string"
- no_ies:
- type: "string"
- co_ies:
- type: "integer"
- co_local_oferta:
- type: "integer"
- no_local_oferta:
- type: "string"
- in_apoio_alimentacao:
- type: "string"
- enum: ["0", "1"]
- in_apoio_bolsa_pemanencia:
- type: "string"
- enum: ["0", "1"]
- in_apoio_bolsa_trabalho:
- type: "string"
- enum: ["0", "1"]
- in_apoio_material_didatico:
- type: "string"
- enum: ["0", "1"]
- in_apoio_moradia:
- type: "string"
- enum: ["0", "1"]
- in_apoio_transporte:
- type: "string"
- enum: ["0", "1"]
- InepLoanReturn:
- type: object
- required: ['result']
- description: |
- This model represents the return possibilities in INEP queries when location information is not needed.
- Note that there will always exists the total and no_ano_pesquisa keys.
- All the other keys are optional and appear if the dims paramter is used.
- properties:
- result:
- type: array
- items:
- type: object
- required: ['total', 'no_ano_pesquisa']
- properties:
- total:
- type: "number"
- no_ano_pesquisa:
- type: "integer"
- format: "int32"
- ds_turno_aluno:
- type: "string"
- enum: ['Integral', 'Matutino', 'Noturno', 'Não aplicável', 'Vespertino']
- ds_sexo_aluno:
- type: "string"
- enum: ['Masculino', 'Feminino']
- ds_cor_raca_aluno:
- type: "string"
- enum: ['Aluno não quis declarar cor/raça', 'Amarela', 'Branca', 'Indígena', 'Parda', 'Preta']
- no_curso:
- type: "string"
- no_ies:
- type: "string"
- co_ies:
- type: "integer"
- refund_fies:
- type: "string"
- enum: ["0", "1"]
- refund_state:
- type: "string"
- enum: ["0", "1"]
- refund_city:
- type: "string"
- enum: ["0", "1"]
- refund_edu_inst:
- type: "string"
- enum: ["0", "1"]
- refund_org:
- type: "string"
- enum: ["0", "1"]
- refund_others:
- type: "string"
- enum: ["0", "1"]
- no_refund_prouni_integral:
- type: "string"
- enum: ["0", "1"]
- no_refund_prouni_partial:
- type: "string"
- enum: ["0", "1"]
- no_refund_state:
- type: "string"
- enum: ["0", "1"]
- no_refund_city:
- type: "string"
- enum: ["0", "1"]
- no_refund_edu_inst:
- type: "string"
- enum: ["0", "1"]
- no_refund_org:
- type: "string"
- enum: ["0", "1"]
- no_refund_others:
- type: "string"
- enum: ["0", "1"]
- co_local_oferta:
- type: "integer"
- no_local_oferta:
- type: "string"
\ No newline at end of file
diff --git a/src/libs/middlewares/reqQueryFields.js b/src/libs/middlewares/reqQueryFields.js
index 424ef59b7137cb87a43871943aac95018e6f790e..74d64d9a28556e2957a52d967dd1bf54063872a7 100644
--- a/src/libs/middlewares/reqQueryFields.js
+++ b/src/libs/middlewares/reqQueryFields.js
@@ -28,6 +28,7 @@ function parseWhereValue(type, value) {
if(type === 'integer') return parseInt(value, 10);
if(type === 'double') return parseFloat(value);
if(type === 'string') return value;
+ if(type === 'like_string') return value;
if(type === 'boolean') {
if(value === null || typeof value === 'boolean') {
return value;
diff --git a/src/libs/routes/SMPPIR/indigenas_territorial.js b/src/libs/routes/SMPPIR/indigenas_territorial.js
index 5667e3868016f14ea4e9cdff8c260d95cc065daa..e88ee4569e669c1b673352fd68123a9ff4fed701 100644
--- a/src/libs/routes/SMPPIR/indigenas_territorial.js
+++ b/src/libs/routes/SMPPIR/indigenas_territorial.js
@@ -80,8 +80,8 @@ rqf.addField({
tableField: 'sigla_uf',
resultField: 'unidade_federativa',
where: {
- relation: '=',
- type: 'string',
+ relation: 'LIKE',
+ type: 'like_string',
field: 'sigla_uf'
}
}).addValue({
@@ -130,8 +130,8 @@ rqf.addField({
tableField: 'regiao',
resultField: 'nome_regiao',
where: {
- relation: '=',
- type: 'string',
+ relation: 'LIKE',
+ type: 'like_string',
field: 'nome_regiao'
}
});