Endereços da pessoa física - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki
Obtendo os endereços de uma pessoa física
Endpoint: /v1/pessoa-fisica/enderecos/{pf_id}/
GET
Retorno:
{
"success":true,
"data":{
"SocialAPI":{
"current":[
{
"end_id":"{id}",
"cidade_cod":999,
"bairro_cod":99,
"end_cep":"78455000",
"end_tipo_lograd":"AVENIDA",
"end_lograd":"Sobe e Desce",
"end_num":"379S",
"end_compl":"Onde ninguém me conhece",
"end_class": "R",
"end_obs": "A casa de mãe",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
}
],
"revisions":[
],
"others":[
]
}
}
}
Forçando flush do cache
Endpoint /v1/pessoa-fisica/enderecos/flush/{pf_id}/
GET
Retorno conforme este endpoint.
Inserindo um endereço
Endpoint: /v1/pessoa-fisica/enderecos/
POST
Payload:
{
"pf_id":"{pf_id}",
"cidade_cod":999,
"bairro_cod":99,
"end_cep":"78455000",
"end_tipo_lograd":"AVENIDA",
"end_lograd":"Sobe e Desce",
"end_num":"379S",
"end_compl":"Onde ninguém me conhece",
"end_class": "R", // R = Residencial, C = Comercial, CR = Correspondência, R = Recado, T = Temporário
"end_obs": "A casa de mãe",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 201
Removendo um endereço
Endpoint: /v1/pessoa-fisica/enderecos/{pf_id}/{end_id}/
DELETE
Payload:
{
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 204