Dependentes(Extras) - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

End-points para manuseio das informações extras dos dependentes de uso exclusivo do IPREF.

Inserindo as informações extras de um dependente

POST: /v1/pessoa-fisica/dep-extras/

Payload:

{
    "parent_id": "0561a97aed99354f0d8c4caed87329cb",
    "pf_id": "4052bb167c025a5b620c7c071aa16fa2",
    "rel": "ytdld6",
    "data_inicio_dep": "2014-04-16",
    "data_fim_dep": null,
    "data_casamento_uniao": "2014-04-16",
    "dep_irrf": "S",
    "dep_previdenciario": "S",
    "observacao": "PA1349/03 INSCRIÇÃO DEPENDENTE"
}

Retorno:

Status code: 201 | 400 | 403 | 404 | 406 | 409

Obtendo as informações extras de um dependente

GET: /v1/pessoa-fisica/dep-extras/{parent_id}/{rel}/{pf_id}/

{
   "success":true,
   "data":{
      "SocialAPI": {
        "parent_id": "0561a97aed99354f0d8c4caed87329cb",
        "pf_id": "4052bb167c025a5b620c7c071aa16fa2",
        "rel": "ytdld6",
        "data_inicio_dep": "2014-04-16",
        "data_fim_dep": null,
        "data_casamento_uniao": "2014-04-16",
        "dep_irrf": "S",
        "dep_previdenciario": "S",
        "observacao": "PA1349/03 INSCRIÇÃO DEPENDENTE"
      }
   }
}

Status code: 200 | 404

Alterando as informações extras de um dependente

PUT: /v1/pessoa-fisica/dep-extras/{parent_id}/{rel}/{pf_id}/

Payload:

{
    "data_inicio_dep": "2014-04-16",
    "data_fim_dep": null,
    "data_casamento_uniao": "2014-04-16",
    "dep_irrf": "S",
    "dep_previdenciario": "S",
    "observacao": "PA1349/03 INSCRIÇÃO DEPENDENTE"
}

Retorno:

Status code: 200 | 400 | 403 | 404 | 406