14. Consultar Família de Itens

Este método permite consultar as famílias cadastradas no sistema Exati. É possível filtrar a busca pelo tipo de item ao qual as famílias estão associadas.

Observe que cada família é identificada pelo seu COD_FAMILIA o qual é composto pelo COD_FAMILIA_PAI (se presente) e pelo COD_SUB_FAMILIA. Além disso, toda família é associada a um tipo de item que, por sua vez, engloba múltiplas famílias.

O endpoint /familia/:cod é para a consulta de uma única família a partir de seu código completo (COD_FAMILIA)

O endpoint /familia permite a consulta de todas as famílias com possibilidade de filtro pelo tipo de item.

Retorno da requisição

Um json com o status da requisição: sucesso ou erro. E com os dados da família única ou os dados das famílias em uma coleção (array). No caso de erro, é retornada uma mensagem descritiva do erro.

Exemplo 1: /familia/FRG.BARRA Sucesso 200 OK

{
    "status": "success",
    "data": {
   	 "ID_FAMILIA": 395,
   	 "ID_FAMILIA_PAI": 384,
   	 "COD_FAMILIA": "FRG.BARRA",
   	 "DESC_FAMILIA": "BARRAS DE COBRE",
   	 "COD_SUB_FAMILIA": "BARRA",
   	 "COD_FAMILIA_PAI": "FRG",
   	 "DESC_FAMILIA_PAI": "FERRAGEM E CONECTOR",
   	 "ID_TIPO_ITEM": 1,
   	 "DESC_TIPO_ITEM": "Material Elétrico",
   	 "SIGLA_TIPO_ITEM": "MTE",
   	 "ENTIDADE": "MATERIAL"
    }
}

Exemplo 2: /familia Sucesso 200 OK

{
    "status": "success",
    "data": {
   	 "familias": [
   		 {
   			 "ID_FAMILIA": 395,
   			 "ID_FAMILIA_PAI": 384,
   			 "COD_FAMILIA": "FRG.BARRA",
   			 "DESC_FAMILIA": "BARRAS DE COBRE",
   			 "COD_SUB_FAMILIA": "BARRA",
   			 "COD_FAMILIA_PAI": "FRG",
   			 "DESC_FAMILIA_PAI": "FERRAGEM E CONECTOR",
   			 "ID_TIPO_ITEM": 1,
   			 "DESC_TIPO_ITEM": "Material Elétrico",
   			 "SIGLA_TIPO_ITEM": "MTE",
   			 "ENTIDADE": "MATERIAL"
   		 },
   		 {
   			 "ID_FAMILIA": 191,
   			 "ID_FAMILIA_PAI": 189,
   			 "COD_FAMILIA": "CIV.CONC",
   			 "DESC_FAMILIA": "CONCRETO PRÉ MISTURADO",
   			 "COD_SUB_FAMILIA": "CONC",
   			 "COD_FAMILIA_PAI": "CIV",
   			 "DESC_FAMILIA_PAI": "CONSTRUÇÃO CIVIL",
   			 "ID_TIPO_ITEM": 2,
   			 "DESC_TIPO_ITEM": "Material Civil",
   			 "SIGLA_TIPO_ITEM": "MTC",
   			 "ENTIDADE": "MATERIAL"
   		 }
   	 ]
   }
}

Exemplo Postman:

14. Consultar Família de Itens

Retorno da requisição#

Retorno da requisição