Nome - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Obtendo o nome de uma pessoa

GET

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

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "data_hora_cache":"2017-10-13 11:36:43",
         "revisions":[
            {
               "pf_nome":"Nome da pessoa",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "pf_nome":"Nome da pessoa",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "files":[
            {
               "pf_nome_file_id":"{id}",
               "file_url":"url-image.jpg",
               "width":675,
               "height":325,
               "coordinate_x":90,
               "coordinate_y":120,
               "rotate":90.00,
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ]
      },
      "others":{
         "pf_nome":"Nome da pessoa",
         "author":{
            "oid":"{oid}",
            "uupfid":"{uupfid}",
            "nome":"Nome do autor",
            "timestamp":123123
         }
      }
   }
}

Alterando o nome de uma pessoa

PUT

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

Payload:

{
   "pf_nome":"Novo nome da pessoa",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 200

Vinculando uma imagem a um nome

POST

Endpoint: /v1/pessoa-fisica/nome/doc/

Payload:

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

Retorno:

Status code: 201

{
   "success":true,
   "data":{
      "SocialAPI":{
         "pf_nome_file_id":"{id}",
         "pf_id":"{id}",
         "file_id":"{id}"
      }
   }
}

Removendo o vínculo de uma imagem de um nome

DELETE

Endpoint: /v1/pessoa-fisica/nome/doc/{pf_id}/{pf_nome_file_id}/

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

Retorno:

Status code: 204