CTPS Contratos

Obtendo os contratos de uma CTPS

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

GET

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "revisions":[
            {
               "pf_ctps_contr_hist_id":"{id}",
               "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_hist_id":"{id}",
               "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
               }
            }
         ],
         "files":[
            {
               "pf_ctps_contr_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_contr_hist_id":"{id}",
            "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
            }
         }
      }
   }
}

Inserindo um contrato para uma CTPS

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

POST

Payload:

{
   "pf_ctps_id":"{pf_ctps_id}",
   "pf_id":"{pf_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

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

PUT

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

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

DELETE

Payload:

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

Retorno:

Status code: 200

Vinculando uma imagem a um contrato de uma CTPS

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

POST

Payload:

{
   "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

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

Removendo a imagem de um contrato de uma CTPS

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

DELETE

Payload:

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

Retorno:

Status code: 200