Documentação da API do STISOFT
Retorna uma lista de pessoas
| identificador | string Identificador da pessoa |
| ativa | boolean Indica se a pessoa está ativa |
{- "code": 200,
- "status": "OK",
- "data": [
- {
- "id": 0,
- "login": "string",
- "identificador": "string",
- "nome": "string",
- "email": "string",
- "nome_empresa": "string",
- "matricula": "string",
- "ativa": true,
- "data_criacao": "string",
- "data_ultima_ativacao": "string",
- "data_hora_ultimo_acesso": "string",
- "quantidade_acessos": 0,
- "grupos": [
- {
- "id": 0,
- "nome": "string",
- "tipos": [
- {
- "id": 0,
- "nome": "string"
}
]
}
]
}
], - "links": {
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "to": 0,
- "path": "string",
- "per_page": 0
}
}Retorna o histórico de acessos de pessoas
| dataInicio required | string <date> Data de início inicial |
| dataFim required | string <date> Data de início final |
| identificador | string Identificador da pessoa |
{- "code": 200,
- "status": "OK",
- "data": [
- {
- "id_pessoa": 0,
- "login": "string",
- "identificador": "string",
- "pessoa_nome": "string",
- "pessoa_email": "string",
- "id_curso": 0,
- "nome_curso": "string",
- "id_historico_curso": 0,
- "data_inicio_curso": "string",
- "data_conclusao_curso": "string",
- "data_validade_curso": "string",
- "data_proxima_renovacao_curso": "string",
- "renovando_aula": true,
- "status_curso": "string",
- "id_aula": 0,
- "nome_aula": "string",
- "id_historico_aula": 0,
- "data_inicio_aula": "string",
- "data_conclusao_aula": "string",
- "data_proxima_renovacao_aula": "string",
- "status_aula": "string",
- "percentual_conclusao_curso": 0
}
], - "links": {
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "to": 0,
- "path": "string",
- "per_page": 0
}
}Retorna os históricos de cursos e aulas de uma pessoa
| dataInicioIni | string <date> Data de início inicial |
| dataInicioFim | string <date> Data de início final |
| dataConclusaoIni | string <date> Data de conclusão inicial |
| dataConclusaoFim | string <date> Data de conclusão final |
{- "code": 200,
- "status": "OK",
- "data": [
- {
- "id_pessoa": 0,
- "login": "string",
- "identificador": "string",
- "pessoa_nome": "string",
- "pessoa_email": "string",
- "id_curso": 0,
- "nome_curso": "string",
- "id_historico_curso": 0,
- "data_inicio_curso": "string",
- "data_conclusao_curso": "string",
- "data_validade_curso": "string",
- "data_proxima_renovacao_curso": "string",
- "renovando_aula": true,
- "status_curso": "string",
- "id_aula": 0,
- "nome_aula": "string",
- "id_historico_aula": 0,
- "data_inicio_aula": "string",
- "data_conclusao_aula": "string",
- "data_proxima_renovacao_aula": "string",
- "status_aula": "string",
- "percentual_conclusao_curso": 0
}
], - "links": {
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "to": 0,
- "path": "string",
- "per_page": 0
}
}Retorna os históricos de cursos das pessoas. Caso não seja passado nenhum parâmetro, serão retornados todos os históricos de cursos ordenados por data de início, conclusão e renovação decrescente e pelo nome da pessoa ascendente.
| dataInicioIni | string <date> Example: dataInicioIni=yyyy-mm-dd Data de início inicial |
| dataInicioFim | string <date> Example: dataInicioFim=yyyy-mm-dd Data de início final |
| dataConclusaoIni | string <date> Example: dataConclusaoIni=yyyy-mm-dd Data de conclusão inicial |
| dataConclusaoFim | string <date> Example: dataConclusaoFim=yyyy-mm-dd Data de conclusão final |
| dataRenovacaoIni | string <date> Example: dataRenovacaoIni=yyyy-mm-dd Data de renovação inicial |
| dataRenovacaoFim | string <date> Example: dataRenovacaoFim=yyyy-mm-dd Data de renovação final |
| pessoaIdentificador | string Example: pessoaIdentificador=Busque pelo identificador da pessoa conforme configurado na plataforma Identificador da pessoa |
| historicoStatus | string Enum: "EM_ANDAMENTO" "CONCLUIDO" "PENDENTE_RENOVACAO" "NOVA_AULA" Example: historicoStatus=EM_ANDAMENTO,CONCLUIDO Busque pelo status dos históricos dos cursos, informando um ou mais status separados por vírgula. |
{- "code": 200,
- "status": "OK",
- "data": [
- {
- "pessoa_id": 0,
- "pessoa_identificador": "string",
- "pessoa_nome": "string",
- "pessoa_tipo_documento": "CPF",
- "pessoa_documento": "12345678900 ou 12345678000195",
- "curso_id": 0,
- "nome_curso": "string",
- "turma_id": 0,
- "historico_id": 0,
- "data_hora_inicio": "2023-10-01 12:00:00",
- "data_hora_conclusao": "2023-10-01 12:10:00",
- "data_validade": "2019-08-24",
- "data_renovacao": "2024-10-01",
- "dias_para_renovacao": 365,
- "carga_horas": "00:15:00",
- "status": "EM_ANDAMENTO",
- "percentual": "100.00"
}
], - "links": {
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "to": 0,
- "path": "string",
- "per_page": 0
}
}Retorna o histórico de conclusões de cursos de pessoas
| dataInicio required | string <date> Data de início inicial |
| dataFim required | string <date> Data de início final |
| identificador | string Identificador da pessoa |
{- "code": 200,
- "status": "OK",
- "data": [
- {
- "id_pessoa": 0,
- "login": "string",
- "identificador": "string",
- "pessoa_nome": "string",
- "pessoa_email": "string",
- "cursos": [
- {
- "id_certificado": 0,
- "id_curso": 0,
- "data_conclusao": "string",
- "data_validade": "string",
- "nome_curso": "string",
- "aulas": [
- {
- "id_aula": 0,
- "data_conclusao": "string",
- "nome_aula": "string"
}
]
}
], - "acessos": [
- {
- "data": "string",
- "hora": "string"
}
]
}
], - "links": {
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "to": 0,
- "path": "string",
- "per_page": 0
}
}Retorna uma lista de diálogos de segurança
| pessoa_identificador | string Identificador da pessoa |
| data_inicio_disponibilizacao | string <date> Data de início da disponibilização |
| data_fim_disponibilizacao | string <date> Data de fim da disponibilização |
{- "code": 200,
- "status": "OK",
- "data": [
- {
- "pessoa_identificador": "string",
- "pessoa_nome": "string",
- "pessoa_tipo_documento": "string",
- "pessoa_documento": "string",
- "data_hora_acessou": "string",
- "data_hora_concluiu": "string",
- "tentativas": "Limitada",
- "limite_tentativas_dialogo_seguranca": 0,
- "quantidade_tentativas_realizadas": 0,
- "aprovado": true,
- "status_pessoa": "string",
- "tema": "string",
- "assunto": "string",
- "idioma": "string",
- "data_inicio_disponibilizacao": "string",
- "data_fim_disponibilizacao": "string",
- "data_prorrogacao_disponibilizacao": "string",
- "data_hora_cancelamento": "string",
- "motivo_cancelamento": "string",
- "usuario_cancelou": "string",
- "status_dialogo_seguranca": "string"
}
], - "links": {
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "to": 0,
- "path": "string",
- "per_page": 0
}
}