CTPS

Obtendo as CTPS's de uma pessoa

GET

Endpoint: /v1/pessoa-fisica/ctps/{pf_id}/

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "current":[
            {
               "pf_ctps_id":"{id}",
               "pf_ctps":"123123XX",
               "pf_ctps_serie":"AB1",
               "pf_ctps_emissao":"2001-01-01",
               "pf_ctps_uf":"MT",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "pf_ctps_id":"{id}",
               "pf_ctps":"44444X",
               "pf_ctps_serie":"AB2",
               "pf_ctps_emissao":"2001-01-01",
               "pf_ctps_uf":"MT",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "revisions":[

         ]
      }
   }
}

Forçando o flush do cache

GET

Endpoint: /v1/pessoa-fisica/ctps/flush/{pf_id}/

Retorno conforme o endpoint.

Inserindo uma CTPS

POST

Endpoint: /v1/pessoa-fisica/ctps/

Payload:

{
   "pf_id":"{pf_id}",
   "pf_ctps":"123123XX",
   "pf_ctps_emissao":"2001-01-01",
   "pf_ctps_uf":"MT",
   "pf_ctps_serie":"ABC1",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Alterando uma CTPS

PUT

Endpoint: /v1/pessoa-fisica/ctps/{pf_id}/{pf_ctps_hist_id}/

Payload:

{
   "pf_ctps":"123123XX",
   "pf_ctps_emissao":"2001-01-01",
   "pf_ctps_uf":"MT",
   "pf_ctps_serie":"ABC1",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 200

Removendo uma CTPS

Endpoint: /v1/pessoa-fisica/ctps/{pf_id}/{pf_ctps_id}/

DELETE

Payload:

{
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 204

Vinculando uma imagem a uma CTPS

POST

Endpoint: /v1/pessoa-fisica/ctps/doc/

Payload:

{
   "pf_ctps_id":"{pf_ctps_id}",
   "file_id":"{file_id}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

{
   "success":true,
   "data":{
      "SocialAPI":{
         "pf_ctps_file_id":"{id}",
         "pf_id":"{id}",
         "file_id":"{id}"
      }
   }
}

Removendo a imagem de uma CTPS

DELETE

Endpoint: /v1/pessoa-fisica/ctps/doc/{pf_id}/{pf_ctps_file_id}/

Payload:

{
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 204