...

Expandir

Informações

icon	false
title	GetAll

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableterms

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms

{
"hasNext": false,
"items": [
{
"internalId": "1|1|3|73

|1

",
"companyCode": 1,
"priceTableCode": 3,
"termId": 73,
"levelEducationCode": 1,
"termCode": "2024/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|1|3|74

|1

",
"companyCode": 1,
"priceTableCode": 3,
"termId": 74,
"levelEducationCode": 1,
"termCode": "2024/2",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|1|3|75

|1

",
"companyCode": 1,
"priceTableCode": 3,
"termId": 75,
"levelEducationCode": 1,
"termCode": "2025/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
}
]
}

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

3.1.3 - Filter (Resultado filtrado)

Expandir

Informações

icon	false
title	Filter

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableterms?{campo}={valor}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: termId

Valor: 74

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms?termId=74

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	    "hasNext": false,
	    "items": [
		{
			        {
            "internalId": "1|1|3|74|1",
			            "companyCode": 1,
			            "priceTableCode": 3,
			            "termId": 74,
			            "levelEducationCode": 1,
			            "termCode": "2024/2",
			            "branchCode": 1,
			            "branchName": "Filial Belo Horizonte - Fantasia"
		        }
	    ]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API da Tabela de Preços é possível adotar o padrão OData. Para entender melhor sobre a utilização desse padrão, acesse o link da documentação Utilizando filtros complexos - Exemplos do guia de API - ODATA.

...

Expandir

Informações

title	Parâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações

icon	false
title	Paginação

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableterms?page={valor1}&pageSize={valor2}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 5

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms?page=1&pageSize=5

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": false,
"items": [
{
"internalId": "1|1|3|73|1",
"companyCode": 1,
"priceTableCode": 3,
"termId": 73,
"levelEducationCode": 1,
"termCode": "2024/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|1|3|74|1",
"companyCode": 1,
"priceTableCode": 3,
"termId": 74,
"levelEducationCode": 1,
"termCode": "2024/2",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|1|3|75|1",
"companyCode": 1,
"priceTableCode": 3,
"termId": 75,
"levelEducationCode": 1,
"termCode": "2025/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
}
]
}

...

Expandir

Informações

icon	false
title	GetOne

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableterms/{internalId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3|13273

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms/1|1|3|13273

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCodeinternalId": "1|1|3|73",
    "branchCodecompanyCode": 1,
    "levelEducationCodepriceTableCode": 13,
    "appliedMatrixCodetermId": 13273,
    "priceTableCodelevelEducationCode": 31,
    "branchNametermCode": "Filial Belo Horizonte - Fantasia2024/1",
    "courseCodebranchCode": "1-1",
    "courseNamebranchName": "Curso Tabela de Preços",
    "curriculumGridCode": "1",
    "curriculumGridName": "Matriz Tabela de Preços",
    "majorCode": "1",
    "majorName": "Habilitação  Tabela de Preços",
    "classShiftCode": 11,
    "classShiftName": "INTEGRAL",
    "status": 0,
    "disciplines": [
        {
            "internalId": "1|3|132|1|0001_ES",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "0001_ES",
            "periodCode": 0,
            "periodDescription": "Período fixo",
            "disciplineName": "Estágio Supervisionado",
            "workload": 8.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|001Wal",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "001Wal",
            "periodCode": 0,
            "periodDescription": "Período fixo",
            "disciplineName": "6.Wal ",
            "workload": 5.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|146-1",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "146-1",
            "periodCode": 1,
            "periodDescription": "Período 1",
            "disciplineName": "7.DIREITO COMERCIAL I",
            "workload": 50.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|147-1",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "147-1",
            "periodCode": 1,
            "periodDescription": "Período 1",
            "disciplineName": "DIREITO COMERIAL II",
            "workload": 50.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|148-1",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "148-1",
            "periodCode": 1,
            "periodDescription": "Período 1",
            "disciplineName": "DIREITO PENAL II",
            "actionState": 1
        }
    ],
    "actionState": 0
}Filial Belo Horizonte - Fantasia"
}

3.2 - DELETE

...

3.2.1 - Delete (Excluir um período letivo de ingresso)

Expandir

Informações

icon	false
title	Delete

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableterms/{internalId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3|132

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms/1|1|3|132

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

Obs.: Em caso de sucesso, será retornado o respondeCode = 204 e a resposta em branco.

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	    "code": null,
	    "message": "Não existe um cadastro de Período Letivo Matrizde AplicadaIngresso vinculado aà Tabela de Preços com o ID informado para exclusão.",
	    "detailedMessage": null,
	    "helpUrl": null,
	    "details": null
}

4 - Descrição dos campos JSON de entrada/retorno

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 69

Nova versão 70

Chave

3.1.3 - Filter (Resultado filtrado)

3.2 - DELETE

3.2.1 - Delete (Excluir um período letivo de ingresso)

4 - Descrição dos campos JSON de entrada/retorno

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 69

Nova versão 70

Chave

3.1.3 - Filter (Resultado filtrado)

3.2 - DELETE

3.2.1 - Delete (Excluir um período letivo de ingresso)

4 - Descrição dos campos JSON de entrada/retorno