Composição familiar - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Obtendo os integrantes

GET

Endpoint: /v1/pessoa-fisica/familia/{pf_id}/

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "data_hora_cache": "2017-10-13 16:57:23",
         "ytdld6": [
            {
               "pf_id": "{pf_id}",
               "pf_cpf":null,
               "pf_nome":"Nome do filho",     
               "pf_nascimento":"1983-05-18",
               "timestamp":1504285146,
               "files":{
                  "foto":{
                     "public":[
                        {

                        }
                     ],
                     "private":[
                        {

                        }
                     ]
                  }    
               }               
            }
         ],
         "f4p7xc": [
            {
            
            }
         ],
         "w8tnca": [
            {
          
            }
         ],        
         "tnarzl": [
            {
        
            }
         ],          
         "orad47": [
            {
          
            }
         ],         
         "all2rq": [
            {

            }
         ],     
         "bqcsnt": [
            {

            }
         ],              
      }
   }
}

Forçando o flush do cache

GET

Endpoint: /v1/pessoa-fisica/familia/flush/{pf_id}/

Retorno conforme o endpoint.

Vinculando um integrante

POST

Endpoint: /v1/pessoa-fisica/familia/

Payload:

{
  "pf_id": "{pf_id}",
  "ref_id":"{pf_id}",
  "clas": "ytdld6",
  "device": {
    "id": "7df0723b4c86ab59711ea26c66642c47",
    "log": {
      "lat": -7.9839111,
      "lon": -34.8387671
    }
  }
}

Retorno:

Status code: 201

Desvinculando um integrante

DELETE

Endpoint: /v1/pessoa-fisica/familia/{pf_id}/{ref_id}/

Payload:

{
  "clas": "ytdld6",
  "device": {
    "id": "7df0723b4c86ab59711ea26c66642c47",
    "log": {
      "lat": -7.9839111,
      "lon": -34.8387671
    }
  }
}

Retorno:

Status code: 204


Hashes de meta dados

  • qwm73b -> Deseja desvincular este dependente definitivamente?

  • u48w9u -> Deseja alterar o tipo de vínculo deste dependente em relação ao titular?

  • Todas as hashes -> g6vcxo

  • ytdld6 -> Filhos

  • f4p7xc -> Enteados

  • w8tnca -> Cônjuge

  • tnarzl -> Companheiro(a)

  • orad47 -> Pais

  • all2rq -> Netos

  • bqcsnt -> Irmãos

  • yfu1yn -> Avós