{"swagger":"2.0","info":{"description":"Possui serviços para operar sob os calendários dos discentes da instituição.","title":"Serviços de Calendário","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":"/calendario/v1","tags":[{"name":"calendarios","description":"Informações dos calendários acadêmicos dos discentes."}],"paths":{"/calendarios":{"get":{"tags":["calendarios"],"summary":"Retorna as informações do calendário de discentes de acordo com os parâmetros listados","operationId":"buscarCalendariosUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-discente","in":"query","description":"Identificador do discente (Se for utilizar esse parâmetro, não poderá utilizar o parâmetro 'id-turma')","required":false,"type":"integer","format":"int32"},{"name":"id-unidade","in":"query","description":"Identificador da unidade do calendário","required":false,"type":"integer","format":"int32"},{"name":"ano","in":"query","description":"Ano do calendario desejado","required":false,"type":"integer","format":"int32"},{"name":"periodo","in":"query","description":"Período do calendario desejado","required":false,"type":"integer","format":"int32"},{"name":"sigla-nivel-ensino","in":"query","description":"Nível de ensino do calendario desejado desejado","required":false,"type":"string"},{"name":"vigente","in":"query","description":"Indica se calendario desejado está vigente","required":false,"type":"boolean"},{"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/CalendarioDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/calendarios/{id-calendario}":{"get":{"tags":["calendarios"],"summary":"Retorna as informações do calendário do indentificador informado.","operationId":"buscarCalendarioUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-calendario","in":"path","description":"Identificador do calendário","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CalendarioDTO"}},"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"]}}},"Character":{"type":"object"},"CalendarioDTO":{"type":"object","required":["ano","ano-ferias-vigente","fim-matricula-extraordinaria","fim-matricula-extraordinaria-ferias","fim-matricula-online","fim-matricula-turma-ferias","fim-periodo","fim-periodo-ferias","fim-processamento-matricula","fim-processamento-rematricula","fim-rematricula","id-calendario","id-unidade","inicio-matricula-extraordinaria","inicio-matricula-extraordinaria-ferias","inicio-matricula-online","inicio-matricula-turma-ferias","inicio-periodo","inicio-periodo-ferias","inicio-processamento-matricula","inicio-processamento-rematricula","inicio-rematricula","periodo","periodo-ferias-vigente","sigla-nivel-ensino","vigente"],"properties":{"ano":{"type":"integer","format":"int32","description":"Ano do calendário"},"ano-ferias-vigente":{"type":"integer","format":"int32","description":"O ano de férias atual do calendário"},"fim-matricula-extraordinaria":{"type":"integer","format":"int64","description":"Fim do período de matrícula extraordinária atual do calendário"},"fim-matricula-extraordinaria-ferias":{"type":"integer","format":"int64","description":"Fim do período de matrícula extraordinária em turmas de férias atual do calendário"},"fim-matricula-online":{"type":"integer","format":"int64","description":"Fim do período de matrícula online atual do calendário"},"fim-matricula-turma-ferias":{"type":"integer","format":"int64","description":"Fim do período de matrícula em turmas de férias atual do calendário"},"fim-periodo":{"type":"integer","format":"int64","description":"Fim do período letivo atual do calendário"},"fim-periodo-ferias":{"type":"integer","format":"int64","description":"Data de fim das férias do período em questão"},"fim-processamento-matricula":{"type":"integer","format":"int64","description":"Fim do período de processamento da matrícula online atual do calendário"},"fim-processamento-rematricula":{"type":"integer","format":"int64","description":"Fim do período de processamento da rematrícula atual do calendário"},"fim-rematricula":{"type":"integer","format":"int64","description":"Fim do período de rematrícula atual do calendário"},"id-calendario":{"type":"integer","format":"int32","description":"Identificador do calendário"},"id-unidade":{"type":"integer","format":"int64","description":"Identificador da unidade do discente"},"inicio-matricula-extraordinaria":{"type":"integer","format":"int64","description":"Início do período de matrícula extraordinária atual do calendário"},"inicio-matricula-extraordinaria-ferias":{"type":"integer","format":"int64","description":"Início do período de matrícula extraordinária em turmas de férias atual do calendário"},"inicio-matricula-online":{"type":"integer","format":"int64","description":"Início do período de matrícula online atual do calendário"},"inicio-matricula-turma-ferias":{"type":"integer","format":"int64","description":"Início do período de matrícula em turmas de férias atual do calendário"},"inicio-periodo":{"type":"integer","format":"int64","description":"Início do período letivo atual do calendário"},"inicio-periodo-ferias":{"type":"integer","format":"int64","description":"Data de início das férias do período em questão"},"inicio-processamento-matricula":{"type":"integer","format":"int64","description":"Início do período de processamento da matrícula online atual do calendário"},"inicio-processamento-rematricula":{"type":"integer","format":"int64","description":"Início do período de processamento da rematrícula atual do calendário"},"inicio-rematricula":{"type":"integer","format":"int64","description":"Início do período de rematrícula atual do calendário"},"periodo":{"type":"integer","format":"int32","description":"Periodo do calendário"},"periodo-ferias-vigente":{"type":"integer","format":"int32","description":"O periodo de férias atual do calendário"},"sigla-nivel-ensino":{"description":"Nivel acadêmico do calendário","$ref":"#/definitions/Character"},"vigente":{"type":"boolean","example":false,"description":"Indica se o calendário está vigente "}},"description":"Representa uma Calendario da Instituição"}}}