Relatórios

Obtendo relatórios

GET: /v1/relatorios/{types}/{offset}/{limit}/

Retorno:

{
  "status": true,
  "data": {
    "SocialAPI": [
      {
        "id": "5218650135974101770",
        "uupfid": "4799192428953130775",
        "type": "servidores",
        "promise": [
          {
            "status": "_done",
            "datetime": "2019-09-18 14:01:36",
            "file": {
              "file_url_pdf": "http://bit.ly/32Qff3i",
              "file_url_original": "https://s3-sa-east-1.amazonaws.com..."
            }
          },
          {
            "status": "_progress",
            "datetime": "2019-09-18 13:50:03"
          },
          {
            "status": "_created",
            "datetime": "2019-09-18 13:46:15"
          }
        ],
        "params": {
          "oeid": "10a847803d538b92eab94d19766737",
          "date_start": null,
          "date_end": null,
          "categoria": null,
          "lotacao": null,
          "fields": [],
          "filter": []
        }
      }
    ]
  }
}

Solicitando um novo relatório

POST: /v1/relatorios/

Validação do body:

• Os campos date_start, date_end, lotacao e categoria são opcionais, para tanto, informar com valor null.
• Tipos de relatórios disponíveis (type):
  • servidores, servidores-inativos

Payload:

{
   "date_start":"aaaa-mm-dd",
   "date_end":"aaaa-mm-dd",
   "lotacao": "SECRETARIA DE SAUDE",
   "categoria": [1, 2],
   "cargo": "PROFESSOR",
   "type":"servidores",
   "fields": [],
   "filters": []
}

Retorno:

Status code: 201

Fields

categoria, matricula, data_admissao, matricula_pensionista, lotacao, cargo, cargo_data_ingresso, tipo_beneficio, paridade, data_concessao, portaria, data_publicacao, tipo_portaria, condicao_atual, data_condicao_atual, ipref_saude, rpps_antigo, numero_previdenciario, sequencial, tipo_vinculo, tipo_plano, poder, tipo_administracao, exposto_agente_nocivo, data_exposto_agente_nocivo, efetivo_magisterio, fessor_superior, data_inicio_abono, motivo_desligamento, data_desligamento, instituidor, nome, cpf, nome_social, nascimento, idade, obito, sexo, estado_civil, data_casamento_uniao, pne, pne_tipo, pne_grau, pne_data, naturalidade, nacionalidade, etnia, escolaridade, nome_pai, nome_mae, telefone_fixo, telefone_celular, telefone_classificacao, telefone_obs, email, email_tipo, endereco, end_numero, end_complemento, cep, bairro, cidade, end_uf, end_classificao, end_obs, rg_numero, rg_emissao, rg_emissor, rg_uf, titulo_numero, titulo_secao, titulo_zona, titulo_emissao, titulo_localidade, cnh, cnh_validade, cnh_primeira_hab, cnh_categoria, cnh_obs, cnh_emissao, cnh_localidade, ppn_numero, ppn_emissao, reservista, reservista_emissao, curso_nome, curso_tipo, curso_situacao, curso_conclusao, certidao_tipo, certidao_numero, certidao_livro, certidao_pagina, carteira_nome, carteira_numero, carteira_emissao, carteira_validade, ctps, ctps_contratos, ctc, ctc_contratos, observacao_1, observacao_2, dependentes, tutela

Filters

• Select (As opções dos campos que são select)
  • categoria, lotacao, cargo, tipo_beneficio, tipo_portaria, condicao_atual, tipo_vinculo, tipo_plano, poder, tipo_administracao, motivo_desligamento, sexo, estado_civil, pne_tipo, pne_grau, naturalidade, nacionalidade, etnia, escolaridade, telefone_classificacao, email_tipo, end_uf, end_classificacao, rg_emissor, rg_uf, cnh_categoria, cnh_localidade, curso_tipo, curso_situacao, certidao_tipo, carteira_nome, ctps_uf, ctc_contratos_iniciativa, ctc_contratos_regime
• Data exata ou intervalo
  • data_admissao, cargo_data_ingresso, data_concessao, data_publicacao, data_condicao_atual, data_exposto_agente_nocivo, data_inicio_abono, data_desligamento, data_nascimento, obito, data_casamento_uniao, pne_data, rg_emissao, titulo_emissao, cnh_validade, cnh_primeira_hab, cnh_emissao, ppn_emissao, reservista_emissao, carteira_emissao, carteira_validade, ctps_data_emissao, ctps_contrato_data_inicio, ctps_contrato_data_fim, ctc_data_emissao, ctc_contrato_inicio, ctc_contrato_fim
• Texto exato ou similar
  • matricula, matricula_pensionista, portaria, rpps_antigo, numero_previdenciario, sequencial, nome, cpf, nome_social, nome_pai, nome_mae, telefone_fixo, telefone_celular, telefone_obs, email, endereco, end_numero, end_complemento, cep, bairro, cidade, end_obs, rg_numero, titulo_numero, titulo_secao, titulo_zona, titulo_localidade, cnh, cnh_obs, ppn_numero, reservista, curso_nome, certidao_numero, certidao_livro, certidao_pagina, carteira_numero, ctps_numero, ctps_serie, ctps_contrato_cnpj, ctc_numero, ctc, ctc_emitente, ctc_cnpj, ctc_contrato_cnpj, ctc_contrato_cargo, ctc_contrato_empregador, observacao
• Numero exato, maior ou menor
  • idade, curso_conclusao, ctps_total_dias, ctc_dias_rpps, ctc_dias_rgps, ctc_dias_publicos, ctc_dias_privados, ctc_contrato_dias_liquidos, ctc_contrato_dias_descontar
• Boolean
  • paridade, ipref_saude, exposto_agente_nocivo, efetivo_magisterio, professor_superior, instituidor, pne, ctc_contrato_sem_contribuicao, ctc_contrato_cargo_especial

Exemplo de filtro

    {
        "filters": [
            "categoria": [1, 2, 3]  // select - multiplas opçôes
            "data_admissao": {"inicio": "2020-01-01", "fim": "2020-01-01"}  // data exata
            "cargo_data_ingresso": {"inicio": "2020-01-01", "fim": "2021-01-01"}  // data intervalo
            "matricula": {"value": "12356", "tipo": "exato"}  // texto exato
            "nome": {"value": "andre", "tipo": "similar"}  // texto similar
            "idade": {"value": 21, "tipo": "exato"}  // numero exato
            "ctps_total_dias": {"value": 100, "tipo": "maior"}  // numero maior
            "curso_conclusao": {"value": 2022, "tipo": "menor"}  // numero menor
            "paridade": true  // boolean
        ]
    }

Removendo um relatório

DELETE: /v1/relatorios/{report_id}/

Payload: {empty}

Retorno:

Status code: 204, 404

Collection

{
   "id":"",
   "oid":"",
   "uupfid":"",
   "type":"vhky6p",
   "promise":[
      {
         "status":"done",
         "datetime":"",
         "file":{
            "file_url_pdf":"",
            "file_url_csv":""
         }
      },
      {
         "status":"progress",
         "datetime":""
      },
      {
         "status":"queued",
         "datetime":""
      },
      {
         "status":"created",
         "datetime":""
      }
   ],
   "params":{
      "oeid":"",
      "date_start":"",
      "date_end":""
   },
   "status":[
       {
           "active": true,
           "uupfid": "{uupfid}"
           "data_hora": "2019-09-18 13:46:15"
       }
   ]
}

Layout do relatório de servidores e servidores-inativos

Título: Relatório de Servidores {se algum filtro for informado, concatenar o nome aqui, ex: "por Categoria"/"por Lotação"}

Órgão: {nome_do_oid_token} Entidade: {nome_do_oeid_token}

Caso algum filtro seja aplicado: Intervalo: {data_inicio}/{data_fim} Categoria: {categoria} Cargo: {cargo_nome}

CPF;Matrícula;Nome;Sexo;Nascimento;