CTPS Contratos - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki
Obtendo os contratos de uma CTPS
GET: /v1/pessoa-fisica/ctps/contratos/{pf_id}/{pf_ctps_id}/
Retorno:
{
"success":true,
"data":{
"SocialAPI":{
"current":[
{
"pf_ctps_contr_id":"{id}",
"pf_ctps_contr_inicio":"2001-01-01",
"pf_ctps_contr_term":"2001-12-31",
"pf_ctps_contr_cnpj":"12658085000189",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
},
{
"pf_ctps_contr_id":"{id}",
"pf_ctps_contr_inicio":"2001-01-01",
"pf_ctps_contr_term":"2001-12-31",
"pf_ctps_contr_cnpj":"12658085000189",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
}
],
"revisions":[
]
}
}
}
Forçando o flush do cache
GET: /v1/pessoa-fisica/ctps/contratos/flush/{pf_id}/{pf_ctps_id}/
Retorno conforme o endpoint.
Inserindo um contrato para uma CTPS
POST: /v1/pessoa-fisica/ctps/contratos/
Payload:
{
"pf_id":"{pf_id}",
"pf_ctps_id": "{pf_ctps_id}",
"pf_ctps_contr_inicio":"2001-01-01",
"pf_ctps_contr_term":"2001-12-31",
"pf_ctps_contr_cnpj":"12658085000189",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 201
Alterando um contrato de uma CTPS
PUT: /v1/pessoa-fisica/ctps/contratos/{pf_id}/{pf_ctps_contr_id}/
Payload:
{
"pf_ctps_contr_inicio":"2002-01-01",
"pf_ctps_contr_term":"2002-12-31",
"pf_ctps_contr_cnpj":"10582517000190",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 200
Removendo um contrato de uma CTPS
DELETE: /v1/pessoa-fisica/ctps/contratos/{pf_id}/{pf_ctps_contr_id}/
Payload:
{
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 204
Obtendo as imagens individuais de cada contrato
GET: /v1/pessoa-fisica/ctps/contratos/doc/{pf_id}/{pf_ctps_id}/
Retorno:
{
"success":true,
"data":{
"SocialAPI":{
"files":[
{
"pf_ctps_contr_id":"{id}",
"file_id":"{id}",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
}
]
}
}
}
Vinculando uma imagem a um contrato de uma CTPS
POST: /v1/pessoa-fisica/ctps/contratos/doc/
Payload:
{
"pf_id":"{pf_id}",
"pf_ctps_id":"{pf_ctps_id}",
"pf_ctps_contr_id":"{pf_ctps_contr_id}",
"file_id":"{file_id}",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 201
Removendo a imagem de um contrato de uma CTPS
DELETE: /v1/pessoa-fisica/ctps/contratos/doc/
Payload:
{
"pf_id":"{pf_id}",
"pf_ctps_id":"{pf_ctps_id}",
"pf_ctps_contr_id":"{pf_ctps_contr_id}",
"file_id":"{file_id}",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 204