8.2 Consultar anos letivos

Request

Request

query AcademicYears {
    academicYears(take: 1) {
        items {
            year
            companyId
            id
            refId
            externalId
            creationDate
            active
            deleted
            lastUpdateDate
        }
    }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	AcademicYearFilterInput	Objeto que define os critérios de filtragem para os anos letivos.
order	[AcademicYearSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto AcademicYearFilterInput

Campo	Tipo	Descrição
academicLevels	ListFilterInputTypeOfAcademicLevelFilterInput	Filtro para níveis acadêmicos associados ao ano letivo
active	BooleanOperationFilterInput	Filtro para o status de ativação do ano letivo
and	[AcademicYearFilterInput!]	Combina filtros usando a lógica AND
changes	ListFilterInputTypeOfLogHistoryFilterInput	Filtro para o histórico de alterações do ano letivo
company	CompanyFilterInput	Filtro para os dados da empresa relacionada ao ano letivo
companyId	IntOperationFilterInput	Filtro para o ID da empresa relacionada ao ano letivo
creationDate	DateTimeOperationFilterInput	Filtro para a data de criação do ano letivo
deleted	BooleanOperationFilterInput	Filtro para o status de deleção do ano letivo
externalId	IntOperationFilterInput	Filtro para o ID externo do ano letivo
id	IntOperationFilterInput	Filtro para o ID do objeto da requisição do ano letivo
lastUpdateDate	DateTimeOperationFilterInput	Filtro para a data da última atualização do ano letivo
or	[AcademicYearFilterInput!]	Combina filtros usando a lógica OR
refId	UuidOperationFilterInput	Filtro para o ID de referência do ano letivo
year	StringOperationFilterInput	Filtro para o ano letivo (ex: 2023/2024)

Objeto AcademicYearSortInput

Campo	Tipo	Descrição
active	SortEnumType	Critério de ordenação para o status de ativação do ano letivo
company	CompanySortInput	Critério de ordenação para os dados da empresa relacionada ao ano letivo
companyId	SortEnumType	Critério de ordenação para o ID da empresa relacionada ao ano letivo
creationDate	SortEnumType	Critério de ordenação para a data de criação do ano letivo
deleted	SortEnumType	Critério de ordenação para o status de deleção do ano letivo
externalId	SortEnumType	Critério de ordenação para o ID externo do ano letivo
id	SortEnumType	Critério de ordenação para o ID do objeto da requisição do ano letivo
lastUpdateDate	SortEnumType	Critério de ordenação para a data da última atualização do ano letivo
refId	SortEnumType	Critério de ordenação para o ID de referência do ano letivo
year	SortEnumType	Critério de ordenação para o ano letivo

Response

Response

{
    "data": {
        "academicYears": {
            "items": [
                {
                    "year": "2024",
                    "companyId": 10,
                    "id": 6,
                    "refId": "e8fb934d-4ff1-4b68-bd5b-8c074711ec37",
                    "externalId": null,
                    "creationDate": "2024-05-20T03:36:55.999Z",
                    "active": true,
                    "deleted": false,
                    "lastUpdateDate": null
                }
            ]
        }
    }
}

Result

Campo	Tipo	Descrição
academicYears	AcademicYearCollectionSegment	Coleção de anos letivos

Objeto AcademicYearsCollectionSegment

Campo	Tipo	Descrição
items	[AcademicYear!]	Lista de objetos do tipo AcademicYear
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.