Endereços da pessoa física(v2) - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Inserindo um endereço

Endpoint: /v2/pessoa-fisica/enderecos/

POST

Payload:

{
   "pf_id": "{pf_id}",
   "end_cidade": "Olinda",
   "end_uf": "PE",
   "end_bairro": "JARDIM ATLÂNTICO",
   "end_cep": "53140140",
   "end_tipo_lograd":"RUA",
   "end_lograd": "JORNALISTA EDSON REGIS",
   "end_num": "1344",
   "end_compl": "PERTO DO MAR",
   "end_class": "C", // R = Residencial, C = Comercial, CR = Correspondência, RC = Recado, T = Temporário
   "end_obs": "(long text)"
}

Retorno:

Status code: 201

{
   "success":true,
   "data":{
      "SocialAPI":{
         "end_id": "{end_id}"
      }
   }
}

Obtendo os endereços de uma pessoa física

Endpoint: /v2/pessoa-fisica/enderecos/{pf_id}/

GET

Retorno:

{
  "success": true,
  "data": {
    "SocialAPI": [
      {
        "end_id": "{id}",
        "end_cidade": "Olinda",
        "end_uf": "PE",
        "end_bairro": "JARDIM ATLÂNTICO",
        "end_cep": "53140140",
        "end_tipo_lograd": "RUA",
        "end_lograd": "JORNALISTA EDSON REGIS",
        "end_num": "1344",
        "end_compl": "PERTO DO MAR",
        "end_class": "C",
        "end_obs": "(long text)",
        "author": {
          "oid": "{oid}",
          "uupfid": "{uupfid}",
          "nome": "Nome do autor",
          "timestamp": 123123
        }
      }
    ]
  }
}

Removendo um endereço

Endpoint: /v2/pessoa-fisica/enderecos/{pf_id}/{end_id}/

DELETE

Payload: (empty) Retorno:

Status code: 204