GET api/v1/analisecredito/pessoafisica/grupofamiliar?analise={analise}&matricula={matricula}

Request Information

URI Parameters

Name	Description	Type	Additional information
analise		integer	Required
matricula		integer	Default value is 0

Requires Authorization!

Roles: analisecredito-consultar

Body Parameters

None.

Response Information

Resource Description

ResultOfGrupoFamiliarDto

Name	Description	Type	Additional information
Data		GrupoFamiliarDto	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "Associado": [
      {
        "Celular1": "sample string 1",
        "Celular2": "sample string 2",
        "Cidade": "sample string 3",
        "CPF": "sample string 4",
        "RG": "sample string 5",
        "DataAdmissao": "2025-08-13T23:42:41.6466221-03:00",
        "DataNascimento": "2025-08-13T23:42:41.6466221-03:00",
        "Endereco": "sample string 6",
        "EnderecoLarDigital": {
          "Endereco": "sample string 1",
          "Cidade": "sample string 2",
          "Unidade": "sample string 3"
        },
        "Filial": {
          "Codigo": 1,
          "CodigoMunicipio": 2,
          "CodigoIBGE": 3,
          "Nome": "sample string 4",
          "Cidade": "sample string 5",
          "FilialMae": 6,
          "Telefones": [
            {
              "Numero": "sample string 1",
              "IsPrincipal": true
            },
            {
              "Numero": "sample string 1",
              "IsPrincipal": true
            }
          ],
          "Uf": "sample string 7",
          "Cnpj": "sample string 8"
        },
        "Matricula": 7,
        "Nome": "sample string 8",
        "Sexo": "sample string 9",
        "TelefoneComercial": "sample string 10",
        "TelefoneResidencial": "sample string 11",
        "TipoMatricula": "Associado",
        "UF": "sample string 12",
        "MatriculaCredito": 13,
        "Ativo": true,
        "MatriculasAssociado": [
          {
            "Matricula": 1,
            "Status": true
          },
          {
            "Matricula": 1,
            "Status": true
          }
        ]
      },
      {
        "Celular1": "sample string 1",
        "Celular2": "sample string 2",
        "Cidade": "sample string 3",
        "CPF": "sample string 4",
        "RG": "sample string 5",
        "DataAdmissao": "2025-08-13T23:42:41.6466221-03:00",
        "DataNascimento": "2025-08-13T23:42:41.6466221-03:00",
        "Endereco": "sample string 6",
        "EnderecoLarDigital": {
          "Endereco": "sample string 1",
          "Cidade": "sample string 2",
          "Unidade": "sample string 3"
        },
        "Filial": {
          "Codigo": 1,
          "CodigoMunicipio": 2,
          "CodigoIBGE": 3,
          "Nome": "sample string 4",
          "Cidade": "sample string 5",
          "FilialMae": 6,
          "Telefones": [
            {
              "Numero": "sample string 1",
              "IsPrincipal": true
            },
            {
              "Numero": "sample string 1",
              "IsPrincipal": true
            }
          ],
          "Uf": "sample string 7",
          "Cnpj": "sample string 8"
        },
        "Matricula": 7,
        "Nome": "sample string 8",
        "Sexo": "sample string 9",
        "TelefoneComercial": "sample string 10",
        "TelefoneResidencial": "sample string 11",
        "TipoMatricula": "Associado",
        "UF": "sample string 12",
        "MatriculaCredito": 13,
        "Ativo": true,
        "MatriculasAssociado": [
          {
            "Matricula": 1,
            "Status": true
          },
          {
            "Matricula": 1,
            "Status": true
          }
        ]
      }
    ],
    "Detalhes": [
      {
        "Matricula": 1,
        "Nome": "sample string 2",
        "Porcentagem": 3.0,
        "Valor": 4.0,
        "Analise": 5,
        "IsMae": true,
        "GrauParentesco": 7,
        "Associado": [
          {
            "Celular1": "sample string 1",
            "Celular2": "sample string 2",
            "Cidade": "sample string 3",
            "CPF": "sample string 4",
            "RG": "sample string 5",
            "DataAdmissao": "2025-08-13T23:42:41.6466221-03:00",
            "DataNascimento": "2025-08-13T23:42:41.6466221-03:00",
            "Endereco": "sample string 6",
            "EnderecoLarDigital": {
              "Endereco": "sample string 1",
              "Cidade": "sample string 2",
              "Unidade": "sample string 3"
            },
            "Filial": {
              "Codigo": 1,
              "CodigoMunicipio": 2,
              "CodigoIBGE": 3,
              "Nome": "sample string 4",
              "Cidade": "sample string 5",
              "FilialMae": 6,
              "Telefones": [
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                },
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                }
              ],
              "Uf": "sample string 7",
              "Cnpj": "sample string 8"
            },
            "Matricula": 7,
            "Nome": "sample string 8",
            "Sexo": "sample string 9",
            "TelefoneComercial": "sample string 10",
            "TelefoneResidencial": "sample string 11",
            "TipoMatricula": "Associado",
            "UF": "sample string 12",
            "MatriculaCredito": 13,
            "Ativo": true,
            "MatriculasAssociado": [
              {
                "Matricula": 1,
                "Status": true
              },
              {
                "Matricula": 1,
                "Status": true
              }
            ]
          },
          {
            "Celular1": "sample string 1",
            "Celular2": "sample string 2",
            "Cidade": "sample string 3",
            "CPF": "sample string 4",
            "RG": "sample string 5",
            "DataAdmissao": "2025-08-13T23:42:41.6466221-03:00",
            "DataNascimento": "2025-08-13T23:42:41.6466221-03:00",
            "Endereco": "sample string 6",
            "EnderecoLarDigital": {
              "Endereco": "sample string 1",
              "Cidade": "sample string 2",
              "Unidade": "sample string 3"
            },
            "Filial": {
              "Codigo": 1,
              "CodigoMunicipio": 2,
              "CodigoIBGE": 3,
              "Nome": "sample string 4",
              "Cidade": "sample string 5",
              "FilialMae": 6,
              "Telefones": [
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                },
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                }
              ],
              "Uf": "sample string 7",
              "Cnpj": "sample string 8"
            },
            "Matricula": 7,
            "Nome": "sample string 8",
            "Sexo": "sample string 9",
            "TelefoneComercial": "sample string 10",
            "TelefoneResidencial": "sample string 11",
            "TipoMatricula": "Associado",
            "UF": "sample string 12",
            "MatriculaCredito": 13,
            "Ativo": true,
            "MatriculasAssociado": [
              {
                "Matricula": 1,
                "Status": true
              },
              {
                "Matricula": 1,
                "Status": true
              }
            ]
          }
        ]
      },
      {
        "Matricula": 1,
        "Nome": "sample string 2",
        "Porcentagem": 3.0,
        "Valor": 4.0,
        "Analise": 5,
        "IsMae": true,
        "GrauParentesco": 7,
        "Associado": [
          {
            "Celular1": "sample string 1",
            "Celular2": "sample string 2",
            "Cidade": "sample string 3",
            "CPF": "sample string 4",
            "RG": "sample string 5",
            "DataAdmissao": "2025-08-13T23:42:41.6466221-03:00",
            "DataNascimento": "2025-08-13T23:42:41.6466221-03:00",
            "Endereco": "sample string 6",
            "EnderecoLarDigital": {
              "Endereco": "sample string 1",
              "Cidade": "sample string 2",
              "Unidade": "sample string 3"
            },
            "Filial": {
              "Codigo": 1,
              "CodigoMunicipio": 2,
              "CodigoIBGE": 3,
              "Nome": "sample string 4",
              "Cidade": "sample string 5",
              "FilialMae": 6,
              "Telefones": [
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                },
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                }
              ],
              "Uf": "sample string 7",
              "Cnpj": "sample string 8"
            },
            "Matricula": 7,
            "Nome": "sample string 8",
            "Sexo": "sample string 9",
            "TelefoneComercial": "sample string 10",
            "TelefoneResidencial": "sample string 11",
            "TipoMatricula": "Associado",
            "UF": "sample string 12",
            "MatriculaCredito": 13,
            "Ativo": true,
            "MatriculasAssociado": [
              {
                "Matricula": 1,
                "Status": true
              },
              {
                "Matricula": 1,
                "Status": true
              }
            ]
          },
          {
            "Celular1": "sample string 1",
            "Celular2": "sample string 2",
            "Cidade": "sample string 3",
            "CPF": "sample string 4",
            "RG": "sample string 5",
            "DataAdmissao": "2025-08-13T23:42:41.6466221-03:00",
            "DataNascimento": "2025-08-13T23:42:41.6466221-03:00",
            "Endereco": "sample string 6",
            "EnderecoLarDigital": {
              "Endereco": "sample string 1",
              "Cidade": "sample string 2",
              "Unidade": "sample string 3"
            },
            "Filial": {
              "Codigo": 1,
              "CodigoMunicipio": 2,
              "CodigoIBGE": 3,
              "Nome": "sample string 4",
              "Cidade": "sample string 5",
              "FilialMae": 6,
              "Telefones": [
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                },
                {
                  "Numero": "sample string 1",
                  "IsPrincipal": true
                }
              ],
              "Uf": "sample string 7",
              "Cnpj": "sample string 8"
            },
            "Matricula": 7,
            "Nome": "sample string 8",
            "Sexo": "sample string 9",
            "TelefoneComercial": "sample string 10",
            "TelefoneResidencial": "sample string 11",
            "TipoMatricula": "Associado",
            "UF": "sample string 12",
            "MatriculaCredito": 13,
            "Ativo": true,
            "MatriculasAssociado": [
              {
                "Matricula": 1,
                "Status": true
              },
              {
                "Matricula": 1,
                "Status": true
              }
            ]
          }
        ]
      }
    ],
    "ValorTotal": 1.0,
    "IsGrupoFamiliar": true
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Lar.Sicop.Entities.CustomDTOs.Empresa.Empresa' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Lar.Sicop.Entities.CustomDTOs.Empresa.Empresa' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.