CTPS

Obtendo as CTPS's de uma pessoa

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

GET

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "revisions":[
            {
               "pf_ctps_hist_id":"{id}",
               "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
               },
               "revisions":[
                  {
                     "pf_ctps_hist_id":"{id}",
                     "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_hist_id":"{id}",
               "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":[
                  {
                     "pf_ctps_hist_id":"{id}",
                     "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
                     }
                  }
               ]
            }
         ],
         "files":[
            {
               "pf_ctps_file_id":"{id}",
               "file_url":"url-image.jpg",
               "width":675,
               "height":325,
               "coordinate_x":90,
               "coordinate_y":120,
               "rotate":90.00,
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "others":{
            "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
            }
         }
      }
   }
}

Inserindo uma CTPS

Endpoint: /v1/pessoa-fisica/ctps/

POST

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

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

PUT

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: 200

Vinculando uma imagem a uma CTPS

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

POST

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

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

DELETE

Payload:

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

Retorno:

Status code: 200