CTC - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki
Obtendo as CTC's de uma pessoa
GET: /v1/pessoa-fisica/ctc/{pf_id}/
Retorno:
{
"success":true,
"data":{
"SocialAPI":{
"current":[
{
"pf_ctc_id":"{id}",
"pf_ctc_num":"123123XX",
"pf_ctc_emissor":"Ministério da Previdência Social",
"pf_ctc_cnpj_emissor":"10582517000190",
"pf_ctc_emissao":"2001-01-01",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
},
{
"pf_ctc_id":"{id}",
"pf_ctc_num":"123123XX",
"pf_ctc_emissor":"Ministério da Previdência Social",
"pf_ctc_cnpj_emissor":"10582517000190",
"pf_ctc_emissao":"2001-01-01",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
}
],
"revisions":[
]
}
}
}
Forçando o flush do cache
GET: /v1/pessoa-fisica/ctc/flush/{pf_id}/
Retorno conforme o endpoint.
Inserindo uma CTC
POST: /v1/pessoa-fisica/ctc/
Payload:
{
"pf_id":"{pf_id}",
"pf_ctc_num":"123123XX",
"pf_ctc_emissor":"Ministério da Previdência Social",
"pf_ctc_cnpj_emissor":"10582517000190",
"pf_ctc_emissao":"2001-01-01",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
{
"success":true,
"data":{
"SocialAPI": {
"pf_ctc_id": "5224736318004296453"
}
}
}
Status code: 201
Alterando uma CTC
PUT: /v1/pessoa-fisica/ctc/{pf_id}/{pf_ctc_id}/
Payload:
{
"pf_ctc_num":"123123XX",
"pf_ctc_emissor":"Ministério da Previdência Social",
"pf_ctc_cnpj_emissor":"10582517000190",
"pf_ctc_emissao":"2001-01-01",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 200
Removendo uma CTC
DELETE: /v1/pessoa-fisica/ctc/{pf_id}/{pf_ctc_id}/
Payload:
{
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 204
Obtendo as imagens de uma CTC
GET: /v1/pessoa-fisica/ctc/doc/{pf_id}/{pf_ctc_id}/
Retorno:
{
"success":true,
"data":{
"SocialAPI":{
"files":[
{
"file_id":"{id}",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
}
]
}
}
}
Vinculando uma imagem a uma CTC
POST: /v1/pessoa-fisica/ctc/doc/
Payload:
{
"pf_id":"{pf_id}",
"file_id":"{file_id}",
"pf_ctc_id":"{pf_ctc_id}",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 201
Removendo a imagem de uma CTC
DELETE: /v1/pessoa-fisica/ctc/doc/
Payload:
{
"pf_id":"{pf_id}",
"file_id":"{file_id}",
"pf_ctc_id":"{pf_ctc_id}",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 204