{"swagger":"2.0","info":{"description":"Possui serviços para operar sob os dados dos docentes externos à instituição.","title":"Serviços de Docente Externo","contact":{"name":"Superintendência de Informática da UFRN - SINFO","url":"http://www.info.ufrn.br","email":"api@info.ufrn.br"}},"host":"api.ufrn.br","basePath":"/docente-externo/v1","tags":[{"name":"docente-externo","description":"Serviços de docentes externos."},{"name":"orientacao academica","description":"Serviços de Orientações acadêmicas."}],"paths":{"/docentes-externos":{"get":{"tags":["docente-externo"],"summary":"Retorna as informações dos docentes externos com os critérios informados.","operationId":"buscarDocentesExternosUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"nome","in":"query","description":"Nome do docente externo","required":false,"type":"string"},{"name":"sexo","in":"query","description":"Sexo do docente externo","required":false,"type":"string"},{"name":"cpf","in":"query","description":"CPF do docente externo","required":false,"type":"integer","format":"int64"},{"name":"id-unidade","in":"query","description":"Identificador da unidade de lotação do docente","required":false,"type":"integer","format":"int32"},{"name":"unidade","in":"query","description":"Unidade do docente externo","required":false,"type":"string"},{"name":"id-tipo-docente-externo","in":"query","description":"Identificador(es) da(s) categoria(s) do docente externo","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"tipo-docente-externo","in":"query","description":"Tipo(s) de vínculo do docente externo","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ativo","in":"query","description":"Informação do status da atividade do docente externo","required":false,"type":"boolean"},{"name":"data-cadastro","in":"query","description":"Data de cadastro do docente externo no sistema","required":false,"type":"integer","format":"int64"},{"name":"data-fim","in":"query","description":"Data de fim da docência","required":false,"type":"integer","format":"int64"},{"name":"sigla-nivel","in":"query","description":"Sigla(s) do(s) nível(eis) de ensino que o docente leciona","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"id-modalidade-educacao","in":"query","description":"Identificador da modalidade de educação","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Limite do retorno desejado","required":false,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Inicio do retorno desejado","required":false,"type":"integer","format":"int32"},{"name":"order-asc","in":"query","description":"Campos de ordenação ASC","required":false,"type":"string"},{"name":"order-desc","in":"query","description":"Campos de ordenação DESC","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DocenteExternoDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/docentes-externos/{id-docente-externo}":{"get":{"tags":["docente-externo"],"summary":"Retorna as informações do docente externo.","operationId":"buscarDocenteExternoUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-docente-externo","in":"path","description":"Identificador do docente externo","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DocenteExternoDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/orientacoes-academicas":{"get":{"tags":["orientacao academica"],"summary":"Retorna as informações das orientações acadêmicas de acordo com os critérios informados.","operationId":"buscarOrientacoesAcademicasUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-discente","in":"query","description":"Identificador do discente","required":false,"type":"integer","format":"int32"},{"name":"id-orientacao-academica","in":"query","description":"Identificador da orientação acadêmica","required":false,"type":"integer","format":"int32"},{"name":"cancelada","in":"query","description":"Indica se a orientação acadêmica está cancelada","required":false,"type":"boolean"},{"name":"nivel","in":"query","description":"Lista de níveis","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit","in":"query","description":"Limite do retorno desejado","required":false,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Inicio do retorno desejado","required":false,"type":"integer","format":"int32"},{"name":"order-asc","in":"query","description":"Campos de ordenação ASC","required":false,"type":"string"},{"name":"order-desc","in":"query","description":"Campos de ordenação DESC","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OrientacaoAcademicaDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/orientacoes-academicas/{id-orientacao-academica}":{"get":{"tags":["orientacao academica"],"summary":"Retorna as informações da orientação acadêmica.","operationId":"buscarEquipeProgramaUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-orientacao-academica","in":"path","description":"Identificador da orientação acadêmica","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OrientacaoAcademicaDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","500","501","502","503","504","505","506","507","508","509","510","511"]}}},"DocenteExternoDTO":{"type":"object","required":["cpf","data-cadastro","data-fim","email","id-docente-externo","id-institucional","id-instituicao-ensino","id-tipo-docente-externo","id-unidade","nome","sexo","tipo-docente-externo","unidade"],"properties":{"cpf":{"type":"integer","format":"int64","description":"CPF/CNPJ do docente externo"},"data-cadastro":{"type":"integer","format":"int64","description":"Data de cadastro do docente externo no sistema"},"data-fim":{"type":"integer","format":"int64","description":"Data de fim da docência"},"email":{"type":"string","description":"E-mail do docente externo"},"id-docente-externo":{"type":"integer","format":"int32","description":"Identificador do docente externo"},"id-institucional":{"type":"integer","format":"int64","description":"Identificador institucional do docente externo"},"id-instituicao-ensino":{"type":"integer","format":"int32","description":"Identificador da instituição de ensino do docente"},"id-tipo-docente-externo":{"type":"integer","format":"int32","description":"Identificador do tipo de vínculo do docente externo"},"id-unidade":{"type":"integer","format":"int32","description":"Identificador da unidade do docente externo"},"nome":{"type":"string","description":"Nome do docente externo"},"sexo":{"type":"string","description":"Sexo do docente externo"},"tipo-docente-externo":{"type":"string","description":"Tipo de vínculo do docente externo"},"unidade":{"type":"string","description":"Unidade do docente externo"}},"description":"Representa um docente externo à instituição"},"OrientacaoAcademicaDTO":{"type":"object","properties":{"cancelada":{"type":"boolean","example":false,"description":"Indica se a orientação foi cancelada"},"discente-nome":{"type":"string","description":"Nome do discente"},"docente-nome":{"type":"string","description":"Nome do docente orientador"},"fim":{"type":"integer","format":"int64","description":"Data da finalização da orientação"},"id-discente":{"type":"integer","format":"int32","description":"Identificador do discente"},"id-docente":{"type":"integer","format":"int32","description":"Identificador do docente orientador"},"id-orientacao-academica":{"type":"integer","format":"int32","description":"Identificador da orientação acadêmica"},"inicio":{"type":"integer","format":"int64","description":"Data de início da orientação"},"nivel":{"type":"string","description":"Nível de graduação do discente"},"tipo-orientacao":{"type":"string","description":"Tipo de orientação"}},"description":"Representa uma orientação acadêmica ao docente externo"}}}