Sumário

...

Índice

exclude	Sumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API da Tabela de PreçosPreço - NÃO PUBLICAR utilizando todos os métodos implementados. E as api's complementares referente às matrizes aplicadas e aos período letivo períodos letivos de ingresso associados à tabela de preçospreço. A Para a utilização das api's é importante observar a responsabilidade e o papel de cada uma e o papel dela para o no cadastro e manutenção das informações da tabela de preços.

A API da tabela de preços terá preço tem a responsabilidade de realização das realizar a manutenção das informações das da própria tabela de preços preço e das suas matrizes aplicadas e dos seus períodos letivos de ingressos associados na tabela de preçosà ela. Não sendo possível inserir, alterar ou remover as os dados das disciplinas associadas às matrizes aplicadas. Essa manipulação será de responsabilidade da api da matriz aplicada.

A API da matriz aplicada terá tem a responsabilidade de realização da realizar a manutenção das informações da matriz aplicada e das disciplinas vinculadas à ela. Nessa api será possível alterar e remover a matriz aplicada além de . E inserir, alterar e remover os dados das disciplina vinculada disciplinas vinculadas à matriz aplicada. Nessa api não será possível inserir uma nova matriz aplicada na tabela de preçospreço, essa responsabilidade está na api da tabela de preçospreço.

A API do período letivo de ingresso terá tem a responsabilidade de realizar somente a remoção do período letivo de ingresso na tabela de preçospreço. A responsabilidade de a inclusão e alteração do período letivo de ingresso na tabela de preços é da preço está na própria api da própria tabela de preçospreço.

1 - Tabela de

...

Preço

...

Serão apresentados 5 métodos, os quais foram implementados na API da Tabela de PreçosPreço, são eles:

GET
POST
PUT
DELETE

1.1 - GET

...

1.1.1 - Get All (Recuperar todas as tabelas de preços)

Expandir

Informações

icon	false
title	GetAll

Recupera todas as tabelas de preços sem retornar as listagens das matrizes aplicadas, dos períodos letivos de ingresso por questão de performance. Essas informações serão retornadas com a utilização do GetOne para tabela de preços preço informada.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

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": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de PrecosPreco",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

1.1.2 - Filter (Resultado filtrado)

Expandir

Informações

icon	false
title	Filter

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Valor: 00001

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable?code=00001

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": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de PrecosPreco Um",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API da Tabela de Preços Preço é 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.

1.1.3 - Paginação

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/pricetable?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/pricetable?page=1&pageSize=5

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": true,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de PrecosPreco Um",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 4,
			"internalId": "1|1|4",
			"code": "00002",
			"name": "Tabela de PrecosPreco Dois",
			"recCreatedOn": "2025-02-04T11:07:16.693-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 5,
			"internalId": "1|1|5",
			"code": "00005",
			"name": "Tabela de PreçosPreço 5",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 6,
			"internalId": "1|1|6",
			"code": "00006",
			"name": "Tabela de PreçosPreço 6",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 7,
			"internalId": "1|1|7",
			"code": "00007",
			"name": "Tabela de PreçosPreço 7",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

1.1.4 - Fields (Retorno de campos específicos no resultado)

Expandir

Informações

title	Parâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações

icon	false
title	Fields

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetable?fields={campos}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: code

Campo 2: name

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable?fields=code,name

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": [
		{
			"code": "00001",
			"name": "Tabela de PrecosPreco Um"
		},
		{
			"code": "00002",
			"name": "Tabela de PrecosPreco Dois"
		}
	]
}

1.1.5 - GetOne (Recuperar tabela de

...

preço pelo identificador)

Expandir

Informações

icon	false
title	GetOne

Nessa requisição serão retornadas as listagens das matrizes aplicadas, dos períodos letivos de ingresso da tabela de preços preço informada

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3

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

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

{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 3,
	"internalId": "1|1|3",
	"code": "00001",
	"name": "Tabela de PrecosPreco Um",
	"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de PreçosPreço",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de PreçosPreço",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de PreçosPreço",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	],
	"terms": [],
	"termBranches": [
		{
			"branchCode": 1
		}
	]
}

1.2 - POST

...

1.2.1 - Post (Inserir uma tabela de

...

preço)

Expandir

Informações

icon	false
title	Post

A inclusão de uma nova tabela de preços preço será feita contendo os seus dados, e os dados das suas matrizes aplicadas vinculadas. Não sendo possível inserir a tabela de preços preço com suas matrizes aplicadas contendo suas disciplinas, e os períodos letivos de ingresso dessa tabela de preço. Essas informações serão inseridas em outras api's com essa responsabilidade.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de PrecosPreco via Postman",
	"active": false,
	"appliedMatrixes": []
}
ou 
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de PrecosPreco via Postman",
	"active": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de PreçosPreço",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de PreçosPreço",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de PreçosPreço",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 25,
	"internalId": "1|1|25",
	"code": "00007",
	"name": "Tabela de PrecosPreco via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": []
}
ou
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 12,
	"internalId": "1|1|12",
	"code": "00005",
	"name": "Tabela de PrecosPreco via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 12,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de PreçosPreço",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de PreçosPreço",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de PreçosPreço",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	]
}

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 foi possível incluir/editar a tabela de preçospreço. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

1.3 - PUT

...

1.3.1 - Put (Atualização de uma tabela de

...

preço)

Expandir

Informações

icon	false
title	Patch

A atualização da tabela de preços preço será feita contendo os seus dados e os dados das suas matrizes aplicadas, e os dados dos seus períodos letivos de ingresso. E a inclusão de novos períodos letivos de ingresso. Não sendo possível inserir a tabela de preços preço com suas matrizes aplicadas contendo suas disciplinas. Essas informações serão inseridas em outras api's com essa responsabilidade.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|14

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable/1|1|14

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 14,
	"internalId": "1|1|14",
	"code": "00003",
	"name": "Tabela de PrecosPreco via Postman ALT",
	"active": false,
	"appliedMatrixes": [],
	"terms": []
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCode": 1,
    "levelEducationCode": 1,
    "id": 14,
    "internalId": "1|1|14",
    "code": "00003",
    "name": "Tabela de PrecosPreco via Postman ALT",
    "active": false,
    "priceTableInUse": false,
    "appliedMatrixes": [],
    "terms": []
}

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 foi possível incluir/editar a tabela de preçospreço. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

1.4 - DELETE

...

1.4.1 - Delete (Excluir uma tabela de

...

preço)

Expandir

Informações

icon	false
title	Delete

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|20

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable/1|1|20

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 da tabela de preçospreço informada para exclusão.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

2 - Matriz Aplicada

...

Serão apresentados 3 métodos, os quais foram implementados na API da Matriz Aplicada vinculada à Tabela de PreçosPreço, são eles:

GET
PUT
DELETE

2.1 - GET

...

2.1.1 - Get All (Recuperar todas as matrizes aplicadas)

Expandir

Informações

icon	false
title	GetAll

Recupera todas as matrizes aplicadas sem retornar a listagem das disciplinas vinculadas por questão de performance. Essas informações serão retornadas com a utilização do GetOne para a matriz aplicada informada.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": false,
"items": [
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 132,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "1-1",
"courseName": "Curso Tabela de PreçosPreço",
"curriculumGridCode": "1",
"curriculumGridName": "Matriz Tabela de PreçosPreço",
"majorCode": "1",
"majorName": "Habilitação Tabela de PreçosPreço",
"classShiftCode": 11,
"classShiftName": "INTEGRAL",
"status": 0,
"disciplines": [],
"actionState": 0
}
]
}

2.1.2 - Filter (Resultado filtrado)

Expandir

Informações

icon	false
title	Filter

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: courseCode

Valor: 1-1

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?courseCode=1-1

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": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de PreçosPreço",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de PreçosPreço",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de PreçosPreço",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"disciplines": [],
			"actionState": 0
		}
	]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API da Tabela de Preços Matriz Aplicada é 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.

2.1.3 - Paginação

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/pricetableappliedmatrixes?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/pricetableappliedmatrixes?page=1&pageSize=5

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": true,
"items": [
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 7,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "3-1",
"courseName": "ADMINISTRAÇÃO",
"curriculumGridCode": "4",
"curriculumGridName": "2004/1",
"majorCode": "1",
"majorName": "COMÉRCIO EXTERIOR",
"classShiftCode": 1,
"classShiftName": "MANHÃ",
"status": 0,
"disciplines": [],
"actionState": 0
},
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 8,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "3-1",
"courseName": "ADMINISTRAÇÃO",
"curriculumGridCode": "4",
"curriculumGridName": "2004/1",
"majorCode": "1",
"majorName": "COMÉRCIO EXTERIOR",
"classShiftCode": 2,
"classShiftName": "TARDE",
"status": 0,
"disciplines": [],
"actionState": 0
},
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 9,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "3-1",
"courseName": "ADMINISTRAÇÃO",
"curriculumGridCode": "4",
"curriculumGridName": "2004/1",
"majorCode": "1",
"majorName": "COMÉRCIO EXTERIOR",
"classShiftCode": 3,
"classShiftName": "NOITE",
"status": 0,
"disciplines": [],
"actionState": 0
},
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 10,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "3-1",
"courseName": "ADMINISTRAÇÃO",
"curriculumGridCode": "4",
"curriculumGridName": "2004/1",
"majorCode": "4",
"majorName": "RECURSOS HUMANOS",
"classShiftCode": 1,
"classShiftName": "MANHÃ",
"status": 0,
"disciplines": [],
"actionState": 0
},
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 11,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "3-1",
"courseName": "ADMINISTRAÇÃO",
"curriculumGridCode": "4",
"curriculumGridName": "2004/1",
"majorCode": "4",
"majorName": "RECURSOS HUMANOS",
"classShiftCode": 2,
"classShiftName": "TARDE",
"status": 0,
"disciplines": [],
"actionState": 0
},
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 12,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "3-1",
"courseName": "ADMINISTRAÇÃO",
"curriculumGridCode": "4",
"curriculumGridName": "2004/1",
"majorCode": "4",
"majorName": "RECURSOS HUMANOS",
"classShiftCode": 3,
"classShiftName": "NOITE",
"status": 0,
"disciplines": [],
"actionState": 0
}
]
}

2.1.4 - Fields (Retorno de campos específicos no resultado)

Expandir

Informações

title	Parâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações

icon	false
title	Fields

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableappliedmatrixes?fields={campos}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: code

Campo 2: name

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?fields=courseName,courseCode

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": [
		{
			"code": "00001",
			"name": "Tabela de PrecosPreco Um"
		},
		{
			"code": "00002",
			"name": "Tabela de PrecosPreco Dois"
		}
	]
}

2.1.5 - GetOne (Recuperar matriz aplicada pelo identificador)

Expandir

Informações

icon	false
title	GetOne

Nessa requisição será retornada a matriz aplicada e suas das disciplinas vinculadas.

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableappliedmatrixes/{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/pricetableappliedmatrixes/1|1|3|132

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

{
    "companyCode": 1,
    "branchCode": 1,
    "levelEducationCode": 1,
    "appliedMatrixCode": 132,
    "priceTableCode": 3,
    "branchName": "Filial Belo Horizonte - Fantasia",
    "courseCode": "1-1",
    "courseName": "Curso Tabela de PreçosPreço",
    "curriculumGridCode": "1",
    "curriculumGridName": "Matriz Tabela de PreçosPreço",
    "majorCode": "1",
    "majorName": "Habilitação  Tabela de PreçosPreço",
    "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
}

2.2 - PUT

...

2.2.1 - Put (Atualização de uma matriz aplicada)

Expandir

Informações

icon	false
title	Patch

A atualização da matriz aplicada é realizada somente para atualizar as disciplinas vinculadas à matriz aplicada. E importante no corpo da requisição informar a propriedade "actionState" na tag "disciplines" a ação que deseja conforme descrito na seção "Descrição dos campos JSON de entrada/retorno"

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableappliedmatrixes/{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/pricetableappliedmatrixes/1|1|3|132

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"branchCode": 1,
	"levelEducationCode": 1,
	"appliedMatrixCode": 132,
	"priceTableCode": 3,
	"branchName": "Filial Belo Horizonte - Fantasia",
	"courseCode": "1-1",
	"courseName": "Curso Tabela de PreçosPreço",
	"curriculumGridCode": "1",
	"curriculumGridName": "Matriz Tabela de PreçosPreço",
	"majorCode": "1",
	"majorName": "Habilitação  Tabela de PreçosPreço",
	"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.0,
			"actionState": 1,
			"creditsvalue": 10
		}
	]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"branchCode": 1,
	"levelEducationCode": 1,
	"appliedMatrixCode": 132,
	"priceTableCode": 3,
	"branchName": "Filial Belo Horizonte - Fantasia",
	"courseCode": "1-1",
	"courseName": "Curso Tabela de PreçosPreço",
	"curriculumGridCode": "1",
	"curriculumGridName": "Matriz Tabela de PreçosPreço",
	"majorCode": "1",
	"majorName": "Habilitação  Tabela de PreçosPreço",
	"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",
			"creditsValue": 10.0,
			"periodCode": 0,
			"periodDescription": "Período fixo",
			"disciplineName": "Estágio Supervisionado",
			"workload": 8.0,
			"actionState": 1
		}
	],
	"actionState": 0
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

{
"code": null,
"message": "Não foi possível incluir/editar a tabela de preçospreço. Existe(m) matriz(es) aplicada(s) com id da matriz aplicada inválido.",
"detailedMessage": null,
"helpUrl": null,
"details": null
}

2.3 - DELETE

...

2.3.1 - Delete (Excluir uma matriz aplicada)

Expandir

Informações

icon	false
title	Delete

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableappliedmatrixes/{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/pricetableappliedmatrixes/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 Matriz Aplicada vinculado a Tabela de PreçosPreço com o ID informado para exclusão",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

3 - Período Letivo de Ingresso

...

Serão apresentados 2 métodos, os quais foram implementados na API do Período de Letivo de Ingresso vinculada à Tabela de PreçosPreço, são eles:

GET
DELETE

3.1 - GET

...

3.1.1 - Get All (Recuperar todos períodos de letivo de ingresso)

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

Informações

icon	false
title	Exemplo de Resultado

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

3.1.2 - 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",
            "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 do Período Letivo de Ingresso é 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.

3.1.3 - Paginação

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",
"companyCode": 1,
"priceTableCode": 3,
"termId": 73,
"levelEducationCode": 1,
"termCode": "2024/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|1|3|74",
"companyCode": 1,
"priceTableCode": 3,
"termId": 74,
"levelEducationCode": 1,
"termCode": "2024/2",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|1|3|75",
"companyCode": 1,
"priceTableCode": 3,
"termId": 75,
"levelEducationCode": 1,
"termCode": "2025/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
}
]
}

3.1.4 - Fields (Retorno de campos específicos no resultado)

Expandir

Informações

title	Parâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações

icon	false
title	Fields

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: termCode

Campo 2: branchName

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms?fields=termCode,branchName

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": false,
"items": [
{
"termCode": "2024/1",
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"termCode": "2024/2",
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"termCode": "2025/1",
"branchName": "Filial Belo Horizonte - Fantasia"
}
]
}

3.1.5 - GetOne (Recuperar período letivo de ingresso pelo identificador)

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|73

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

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

{
    "internalId": "1|1|3|73",
    "companyCode": 1,
    "priceTableCode": 3,
    "termId": 73,
    "levelEducationCode": 1,
    "termCode": "2024/1",
    "branchCode": 1,
    "branchName": "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|73

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

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 de Ingresso vinculado à Tabela de PreçosPreço com o ID informado para exclusão.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

4 -

...

Reajuste de valores

...

Nesta sessão serão apresentadas as três APIs principais usadas no reajuste de valores.

GET - http://{domínio}:{porta}/api/educational/v1/financial/pricetablebranchesandterms (Responsável por retornar lista de filiais e os períodos letivos disponíveis para seleção por filial)
POST - http://{domínio}:{porta}/api/educational/v1/financial/simulation/pricetablereadjustment (Responsável pela simulação do reajuste de valores)
POST - http://{domínio}:{porta}/api/educational/v1/financial/pricetableadjustment (Processa o reajuste de valores)

4.1 - Obter filiais e períodos letivos

...

4.1.1 - Get All (Recuperar todas filiais e todos períodos disponíveis para uso no reajuste)

Expandir

Informações

icon	false
title	GetAll

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

Obs: Para execução é obrigatório informar pelos menos 1 internalId de tabela de preço e no máximo 20 internalId de tabela de preço. Cada internalId deve ser separado por ';'.

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|23

internalId: 1|1|24

Url Utilizada: http://localhost:8051/api/educational/v1/financial/pricetablebranchesandterms?1|1|23;1|1|24

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": [
        {
            "companyCode": 1,
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia",
            "priceTableInternalIds": [
                "1|1|23",
                "1|1|24"
            ],
            "terms": [               
                {
                    "internalId": "1|1|74",
                    "companyCode": 1,
                    "priceTableCode": 0,
                    "termId": 74,
                    "levelEducationCode": 0,
                    "termCode": "2024/2",
                    "branchCode": 1
                },
                {
                    "internalId": "1|1|75",
                    "companyCode": 1,
                    "priceTableCode": 0,
                    "termId": 75,
                    "levelEducationCode": 0,
                    "termCode": "2025/1",
                    "branchCode": 1
                }
            ]
        },
        {
            "companyCode": 1,
            "branchCode": 2,
            "branchName": "Filial Rio de Janeiro",
            "priceTableInternalIds": [
                "1|1|23"
            ],
            "terms": [
                {
                    "internalId": "1|2|78",
                    "companyCode": 1,
                    "priceTableCode": 0,
                    "termId": 78,
                    "levelEducationCode": 0,
                    "termCode": "202522",
                    "branchCode": 2
                }
            ]
        }
    ]
}

4.2 - Simular reajuste de valores

...

4.2.1 - POST (Executa simulação do reajuste por matriz aplicada)

Expandir

Informações

icon	false
title	POST

A simulação é realizada por matriz aplicada da tabela de preço, seu retorno é como os valores devem ficar após o reajuste.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/educational/v1/financial/simulation/pricetablereadjustment/

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCode": 1,
    "branchCode": 1,
    "levelEducationCode": 1,
    "appliedMatrixCode": 140,
    "priceTableCode": 24,
    "readjustmentPercent": 2
}

Informações

icon	false
title	Exemplo de Resultado com sucesso (201 - Created)

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCode": 1,
    "priceTableCode": 24,
    "appliedMatrixCode": 140,
    "levelEducationCode": 1,
    "readjustmentPercent": 2.0,
    "disciplines": [
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|A035-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "A035-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "ECONOMIA BRASILEIRA E INTERNACIONAL",
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|A038-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "A038-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "ADMINISTRAÇÃO FINANCEIRA",
            "workload": 68.0000,
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|A144-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "A144-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "INFORMÁTICA",
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|S049-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "S049-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "ÁLGEBRA LINEAR E GEOMETRIA ANALÍTICA",
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|TPD2",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "TPD2",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "MATEMÁTICA 1",
            "actionState": 0
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultado com falha - (500 Internal server error)

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": null,
    "message": "Referência de objeto não definida para uma instância de um objeto.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

4.3 - Processar reajuste de valores

...

4.3.1 - POST (Processa reajuste de valores)

Expandir

Informações

icon	false
title	POST

Efetua o reajuste dos valores da tabela de preço.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCode": 1,
    "levelEducationCode": 1,
    "observation": "Teste de reajuste",
    "readjustmentPercent": 50,
    "priceTables": [
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 23,
            "internalId": "1|1|23",            
            "active": true,
            "statusFillDisciplines": 1,                        
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "termCode": "2025/1",
                    "branchCode": 1                    
                },
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 78,
                    "levelEducationCode": 1,
                    "termCode": "202522",
                    "branchCode": 2
                }
            ]       
        },
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 24,
            "internalId": "1|1|24",            
            "active": true,
            "statusFillDisciplines": 1,
            "priceTableInUse": false,            
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 24,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "termCode": "2025/1",
                    "branchCode": 1                    
                }
            ]           
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultado com sucesso (201 - Created)

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "internalId": "1|1|76",
    "companyCode": 1,
    "levelEducationCode": 1,
    "readjustmentId": 76,
    "priceTables": [
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 23,
            "code": "ENG SOF 2009",
            "name": "ENGENHARIA DE SOFTWARE",
            "statusFillDisciplines": 0,
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "branchCode": 1
                },
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 78,
                    "levelEducationCode": 1,
                    "branchCode": 2
                }
            ]
        },
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 24,
            "code": "TSTRjs",
            "name": "Teste reajuste",
            "statusFillDisciplines": 0,
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 24,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "branchCode": 1
                }
            ]
        }
    ],
    "readjustmentPercent": 50.0,
    "observation": "Teste de reajuste"
}

5 - Processo vínculo Matriz Aplicada e Campus/Polo da Matriz Aplicada

...

O vínculo da tabela de preço como default para a matriz aplicada e/ou campus/polo da matriz aplicada, pode ser realizada pelo método POST da API de JobScheduler.

Expandir

Informações

icon	false
title	Post

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler

Informações

icon	false
title	Exemplo de entrada 3 camadas

Caso a propriedade recurrent seja igual a true, obrigatoriamente deve-se informar o Tipo de Recorrência.

Propriedades obrigatórias:

processID, firstExecution, recurrent, executionParameter

executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "firstExecution": "2025-02-17T18:12:00-03:00",
    "recurrent": false,
    "executionParameter": {
        "Context": {
            "_params": {
                "$CODCOLIGADA": 1,
                "$CODFILIAL": 1,
                "$CODTIPOCURSO": 1,
                "$CODUSUARIO": "mestre",
                "$CODSISTEMA": "S"
            }
        },
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "UserName": "mestre",
        "PrimaryKeyList": [
            [
                "1|1|6"
            ]
        ],
        "PrimaryKeyNames": [
            "internalId"
        ],
        "HostName": "HOST",
        "appliedMatrixCodeList": [
            21,
            25,
            26
        ],
        "appliedMatrixCampusCodeList": [
            "21|1",
            "25|1"
        ]
    }
}

Informações

icon	false
title	Exemplo de entrada ambiente local

Se o Host estiver executando local (3camadas = false) não é possível criar um agendamento de job. Neste cenário, para executar o job imediatamente, é preciso que no Body da requisição a recorrência esteja como 'false' e não sejam enviadas as propriedades "ScheduleDateTime" e Tipo de Recorrência.

Propriedades obrigatórias:

processID, recurrent, executionParameter

executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "recurrent": false,
    "executionParameter": {
        "Context": {
            "_params": {
                "$CODCOLIGADA": 1,
                "$CODFILIAL": 1,
                "$CODTIPOCURSO": 1,
                "$CODUSUARIO": "mestre",
                "$CODSISTEMA": "S"
            }
        },
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "UserName": "mestre",
        "PrimaryKeyList": [
            [
                "1|1|6"
            ]
        ],
        "PrimaryKeyNames": [
            "internalId"
        ],
        "HostName": "HOST",
        "appliedMatrixCodeList": [
            21,
            25,
            26
        ],
        "appliedMatrixCampusCodeList": [
            "21|1",
            "25|1"
        ]
    }
}

Informações

icon	false
title	Exemplo de resultado positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "jobScheduleId": "105783",
    "status": "active",
    "lastModified": "2025-02-17T18:40:27-03:00",
    "processId": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "firstExecution": "2025-02-17T18:40:00-03:00",
    "user": "mestre",
    "recurrent": false,
    "executionParameter": {
        "appliedMatrixCodeList": [
            21,
            25,
            26
        ],
        "appliedMatrixCampusCodeList": [
            "21|1",
            "25|1"
        ],
        "CodColigada": 0,
        "CodFilial": 0,
        "CodTipoCurso": 0,
        "Initialized": false,
        "PrimaryKeyList": [
            [
                "1|1|6"
            ]
        ],
        "PrimaryKeyNames": [
            "internalId"
        ],
        "PrimaryKeyTableName": null,
        "OnlineMode": false,
        "SyncExecution": false,
        "HideProgressDialog": false,
        "SaveParamsExecution": false,
        "CodUsuario": "mestre",
        "Context": {
            "$id": "1",
            "_params": {
                "$CODFILIAL": 1,
                "$CODSISTEMA": "S",
                "$CODCOLIGADA": 1,
                "$CODUSUARIO": "mestre",
                "$CODTIPOCURSO": 1
            },
            "Environment": 0
        },
        "UserName": "mestre",
        "ConnectionId": null,
        "ConnectionString": null,
        "DriverType": null,
        "Ip": null,
        "HostName": "",
        "JobServerHostName": "BHN050104619",
        "ActionName": null,
        "MasterActionName": null,
        "ActionModule": null,
        "JobID": {
            "ID": 105783,
            "ExecID": 1,
            "IsPriorityJob": false,
            "Children": []
        },
        "ShowReExecuteButton": true,
        "ExecutionId": "f414352f-fe43-444c-a437-80cb6390388e",
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "ServerName": null,
        "ServiceInterface": null,
        "Scheduler": 1,
        "UseJobMonitor": true,
        "ScheduleDateTime": "2025-02-17T18:40:26-03:00",
        "CanSendMail": false,
        "CanWaitSchedule": false,
        "SendMail": false,
        "FriendlyLogs": null,
        "SuccessMessage": "Processo executado com sucesso",
        "FailureMessage": "Falha na execução do processo",
        "SaveLogInDatabase": true,
        "StatusMessage": null,
        "WaitSchedule": false,
        "IsolateProcess": false,
        "DisableIsolateProcess": false,
        "NetworkUser": "",
        "CustomData": null,
        "CanParallelize": false,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
    }
}

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": "FE016",
    "Message": "O corpo da mensagem contém valores inválidos.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

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

...

Expandir

title	Descrição dos campos JSON de entrada/retorno

Tabela de Preço

companyCode: Código da coligada
levelEducationCode: Código do nível de ensino/tipo de curso
id: Identificador único da tabela de preço
internalId: Identificador da tabela de preço no formato:
- "Código da Coligada | Código do Nível de Ensino | Identificador da Tabela de Preço"
code: Código da tabela de preço definido pelo usuário no sistema
name: Nome da tabela de preço
reccreatedon: Data de criação da tabela de preço
active: Informa se a tabela de preço está ativa
pricetableinuse: Informa se a tabela de preço está em uso
appliedMatrixes: Listagem das matrizes aplicadas vinculadas à tabela de preço
terms: Listagem dos período letivos de ingresso vinculados à tabela de preço

Matriz Aplicada vinculada à Tabela de Preço

companyCode: Código da coligada
branchCode: Código da filial
levelEducationCode: Código do nível de ensino/tipo de curso
appliedMatrixCode: Identificador da matriz aplicada
priceTableCode: Identificador da tabela de preço
branchName: Nome da filial
courseCode: Código do curso
courseName: Nome do curso
curriculumGridCode: Código da grade/matriz curricular
curriculumGridName: Nome da grade/matriz curricular
majorCode: Código da habilitação
majorName: Nome da habilitação
classShiftCode: Código do turno
classShiftName: Nome do turno
Status: Informar o status do preenchimento do valor de créditos da disciplinas, valores possíveis
- 0: Informa que todas as disciplinas não tem o valor de créditos preenchido
- 1: Informa que têm algumas disciplinas sem ter o valor de créditos preenchido
- 2: Informa que todas as disciplinas já tem o valor de créditos preenchido
disciplines: Listagem das disciplinas vinculadas a matriz aplicada
actionState: Informar o controle de modificação
- 1: Informa a inclusão da matriz aplicada na tabela de preço
- 2: Informa a remoção da matriz aplicada na tabela de preço

Disciplina vinculada à Matriz Aplicada

companyCode: Código da coligada
priceTableCode: Identificador da tabela de preço
appliedMatrixCode: Identificador da matriz aplicada

Expandir

title	Descrição dos campos JSON de entrada/retorno

Tabela de Preços

companyCode: Código da coligada
levelEducationCode: Código do nível de ensino/tipo de curso
id: Identificador único da tabela de preços
internalId: Identificador da tabela de preços no formato:
- "Código da Coligada|Código do Nível de Ensino|Identificador da Tabela de Preços"
code: Código da tabela de preços definido pelo usuário no sistema
name: Nome da tabela de preços
reccreatedon: Data de criação da tabela de preços
active: Informa se a tabela de preços está ativa
pricetableinuse: Informa se a tabela de preços está em uso
appliedMatrixes: Listagem das matrizes aplicadas vinculadas à tabela de preços
terms: Listagem dos período letivos de ingresso vinculados à tabela de preços

Matriz Aplicada vinculada à Tabela de Preços

companyCode: Código da coligada
branchCode: Código da filial
levelEducationCode: Código do nível de ensino/tipo de curso
appliedMatrixCodeinternalId: Identificador da matriz aplicada
priceTableCode: Identificador da tabela de preços
branchName: Nome da filial
courseCode: Código do curso
courseName: Nome do curso
curriculumGridCode: Código da grade/matriz curricular
curriculumGridName: Nome da grade/matriz curricular
majorCode: Código da habilitação
majorName: Nome da habilitação
classShiftCode: Código do turno
classShiftName: Nome do turno
Status: Informar o status do preenchimento do valor de créditos da disciplinas, valores possíveis
- 0: Informa que todas as disciplinas não tem o valor de créditos preenchido
- 1: Informa que têm algumas disciplinas sem ter o valor de créditos preenchido
- 2: Informa que todas as disciplinas já tem o valor de créditos preenchido
disciplines: Listagem das disciplinas vinculadas a matriz aplicada
actionState: Informar o controle de modificação
- 1: Informa a inclusão da matriz aplicada na tabela de preços
- 2: Informa a remoção da matriz aplicada na tabela de preços
disciplina no formato:
- "Código da Coligada | Identificador da Tabela de Preço | Identificador da Matriz Aplicada | Código do Nível de Ensino | Código da Disciplina"
disciplineCode: Código da disciplina
creditsValue: Valor de créditos
periodCode: Código do período
periodDescription: Descrição do período
disciplineName: Nome da disciplina
workload: Número da carga horária da disciplina
actionState: Informar o controle de modificação
- 1: Informa a inclusão da disciplina da matriz aplicada
- 2: Informa a remoção da disciplina da matriz aplicada
- 3: Informa a modificação da disciplina da matriz aplicada
recCreatedBy: Usuário de criação
recCreatedOn: Data de criação
recModifiedBy: Usuário de alteração
recModifiedOn: Data de alteração

Período Letivo de Ingresso vinculado Disciplina vinculada à Matriz Aplicada

companyCode: Código da coligada
priceTableCode: Identificador da tabela de preçosappliedMatrixCode: Identificador da matriz aplicadapreço
levelEducationCode: Código do nível de ensino/tipo de curso
termId: identidicador do período letivo de ingresso
internalId: Identificador da disciplina no formato:
- "Código da Coligada|Identificador da Tabela de PreçosPreço|Identificador da Matriz Aplicadado Período Letivo de Ingresso|Código do Nível de Ensino|Código da Disciplina"
disciplineCode: Código da disciplina
creditsValue: Valor de créditos
periodCode: Código do período
periodDescription: Descrição do período
disciplineName: Nome da disciplina
workload: Número da carga horária da disciplina
actionState: Informar o controle de modificação
- 1: Informa a inclusão da disciplina da matriz aplicada
- 2: Informa a remoção da disciplina da matriz aplicada
- 3: Informa a modificação da disciplina da matriz aplicada
recCreatedBy: Usuário de criação
recCreatedOn: Data de criação
recModifiedBy: Usuário de alteração
recModifiedOn: Data de alteração

Período Letivo de Ingresso vinculado à Matriz Aplicada

- "
termCode: Código do período letivo de ingresso definido pelo usuário no sistema
branchName: Nome da filial
branchCode: Código da filial
actionState: Informar o controle de modificação
- 1: Informa a inclusão do período letivo de ingresso na tabela de preço
- 2: Informa a remoção do período letivo de ingresso na tabela de preço
recCreatedBy: Usuário de criação
recCreatedOn: Data de criação
recModifiedBy: Usuário de alteração
recModifiedOn: Data de alteração

Processo vínculo Matriz Aplicada e/ou Campus/Polo da Matriz Aplicada

processID: Indentificador do processo no RM
- Informar "EduVinculaTabelaPrecoMatrizAplicadaData"
firstExecution: Data da primeira execução do processo agendado
recurrent: Indica se a execução do processo é recorrente
executionParameter: Parâmetros de execução
- Context: Contexto
  - _params
    - $CODCOLIGADA: Código da coligada
    - $CODFILIAL: Código da filial
    - $CODTIPOCURSO: Código do nível de ensino
    - $CODUSUARIO: Código do usuário
    - $CODSISTEMA: Código do sistema
      - Informar "S"
- ProcessName: Nome do processo
  - Informar "Vinculo Matriz Aplicada e Campus/Polo"
- UserName: Nome do usuário
- PrimaryKeyList: Chave primária da tabela de preço
  - "Código da Coligada | Código do Nível de Ensino | Identificador da Tabela de Preço"
- PrimaryKeyNames: Nome da chave primária da tabela de preço
  - Informar "internalId"
- HostName: Nome do host
- appliedMatrixCodeList: Lista de códigos da matriz aplicada
- appliedMatrixCampusCodeList: Lista de códigos do campus/polo da matriz aplicada
  - "Identificador da matriz aplicada | Código do campus/polo"
daily: Utilizar somente se recurrent = true e o tipo de recorrência for diária. Consultar Tipo de Recorrência.
- year: Ano
- month: Mês
- day: Dia
- hour: Hora
- minute: minuto
weekly: Utilizar somente se recurrent = true e o tipo de recorrência for semanal. Consultar Tipo de Recorrência.
- daysOfWeek: Lista de dias da semana
- hour: Hora
- minute: Minutos
monthly: Utilizar somente se recurrent = true e o tipo de recorrência for mensal. Consultar Tipo de Recorrência.
- day: Dia
- hour: Hora
- minute: minuto
companyCode: Código da coligada
priceTableCode: Identificador da tabela de preços
levelEducationCode: Código do nível de ensino/tipo de curso
termId: identidicador do período letivo de ingresso
internalId: Identificador da disciplina no formato:
- "Código da Coligada|Identificador da Tabela de Preços|Identificador do Período Letivo de Ingresso|Código do Nível de Ensino"
termCode: Código do período letivo de ingresso definido pelo usuário no sistema
branchName: Nome da filial
branchCode: Código da filial
actionState: Informar o controle de modificação
- 1: Informa a inclusão do período letivo de ingresso na tabela de preços
- 2: Informa a remoção do período letivo de ingresso na tabela de preços
recCreatedBy: Usuário de criação
recCreatedOn: Data de criação
recModifiedBy: Usuário de alteração
recModifiedOn: Data de alteração

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 74

Nova versão Atual

Chave

Sumário

Objetivo

1 - Tabela de

Preço

1.1 - GET

1.1.1 - Get All (Recuperar todas as tabelas de preços)

1.1.2 - Filter (Resultado filtrado)

1.1.3 - Paginação

1.1.4 - Fields (Retorno de campos específicos no resultado)

1.1.5 - GetOne (Recuperar tabela de

preço pelo identificador)

1.2 - POST

1.2.1 - Post (Inserir uma tabela de

preço)

1.3 - PUT

1.3.1 - Put (Atualização de uma tabela de

preço)

1.4 - DELETE

1.4.1 - Delete (Excluir uma tabela de

preço)

2 - Matriz Aplicada

2.1 - GET

2.1.1 - Get All (Recuperar todas as matrizes aplicadas)

2.1.2 - Filter (Resultado filtrado)

2.1.3 - Paginação

2.1.4 - Fields (Retorno de campos específicos no resultado)

2.1.5 - GetOne (Recuperar matriz aplicada pelo identificador)

2.2 - PUT

2.2.1 - Put (Atualização de uma matriz aplicada)

2.3 - DELETE

2.3.1 - Delete (Excluir uma matriz aplicada)

3 - Período Letivo de Ingresso

3.1 - GET

3.1.1 - Get All (Recuperar todos períodos de letivo de ingresso)

3.1.2 - Filter (Resultado filtrado)

3.1.3 - Paginação

3.1.4 - Fields (Retorno de campos específicos no resultado)

3.1.5 - GetOne (Recuperar período letivo de ingresso pelo identificador)

3.2 - DELETE

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

4 -

Reajuste de valores

4.1 - Obter filiais e períodos letivos

4.1.1 - Get All (Recuperar todas filiais e todos períodos disponíveis para uso no reajuste)

4.2 - Simular reajuste de valores

4.2.1 - POST (Executa simulação do reajuste por matriz aplicada)

4.3 - Processar reajuste de valores

4.3.1 - POST (Processa reajuste de valores)

5 - Processo vínculo Matriz Aplicada e Campus/Polo da Matriz Aplicada

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