...

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 e das filiais dos períodos letivos por questão de performance. Essas informações serão retornadas com a utilização do GetOne para tabela de 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 Precos",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

1.1.2 -

...

Filter (Resultado filtrado)

Expandir

title

Informações

Parâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações

icon	false
title	Order (Asc)Filter

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: namecode

Tipo de OrdenaçãoValor: Ascendente00001

Url Utilizada:http://localhost:8051/api/educational/financial/v1/pricetable?ordercode=name00001

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

{
"hasNext": false,
"items": [
{

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNext": false,
	"items": [
		{

"companyCode": 1,


			"levelEducationCode": 1,


			"id":

4,

 3,
			"internalId": "1|1|

4

3",


			"code": "

00002

00001",


			"name": "Tabela de Precos

Dois

 Um",


			"recCreatedOn": "2025-02-04T11:

07

01:

16

30.

693

617-03:00",


			"active": false,


			"priceTableInUse": false,


			"appliedMatrixes": [],


			"terms": [],


			"termBranches": []

},
{
"companyCode": 1,
"levelEducationCode": 1,
"id": 3,
"internalId": "1|1|3",
"code": "00001",
"name": "Tabela de Precos 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 é 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	Order (Desc)Paginação

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

CampoValor1: name 1

Tipo de OrdenaçãoValor2: Descendente 5

Url Utilizada:http://localhost:8051/api/educational/financial/v1/pricetable?order=-namepage=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": falsetrue,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de Precos 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 Precos Dois",
			"recCreatedOn": "2025-02-04T11:07:16.693-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		]
}

1.1.3 - 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,
			"{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 5,
			"internalId": "1|1|5",
			"code": "00005",
			"name": "Tabela de Preços 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|36",
			"code": "0000100006",
			"name": "Tabela de PrecosPreços Um6",
			"recCreatedOn": "2025-02-04T11:0136:3013.61733-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 é 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.4 - Paginação

		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 7,
			"internalId": "1|1|7",
			"code": "00007",
			"name": "Tabela de Preços 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

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: 8051Valor1

Campo 1: 1code

Valor2Campo 2: 5name

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable?page=1&pageSize=5fields=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": truefalse,
	"items": [
		{
			"companyCodecode": 1"00001",
			"levelEducationCodename": 1,"Tabela de Precos Um"
			"id": 3},
			"internalId": "1|1|3",{
			"code": "0000100002",
			"name": "Tabela de Precos UmDois",
			"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",
		}
	]
}

1.1.5 - GetOne (Recuperar tabela de preços 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 e das filiais dos períodos letivos da tabela de preços

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 Precos DoisUm",
			"recCreatedOn": "2025-02-04T11:0701:1630.693617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
		{
			"termscompanyCode": []1,
			"termBranchesbranchCode": []
		}1,
		{
			"companyCodelevelEducationCode": 1,
			"levelEducationCodeappliedMatrixCode": 1132,
			"idpriceTableCode": 53,
			"internalIdbranchName": "1|1|5Filial Belo Horizonte - Fantasia",
			"codecourseCode": "000051-1",
			"namecourseName": "Curso Tabela de Preços 5",
			"recCreatedOncurriculumGridCode": "2025-02-04T11:36:13.33-03:001",
			"activecurriculumGridName": false"Matriz Tabela de Preços",
			"priceTableInUsemajorCode": false"1",
			"appliedMatrixesmajorName": [] "Habilitação  Tabela de Preços",
			"termsclassShiftCode": []11,
			"termBranchesclassShiftName": []
		}"INTEGRAL",
		{
			"companyCodestatus": 10,
			"levelEducationCodeactionState": 1,0
			"id": 6,
			"internalId": "1|1|6",
			"code": "00006",
			"name": "Tabela de Preços 6",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
		}
	],
	"terms": [],
			"termBranches": []
		},
		{
			"companyCodebranchCode": 1,
			"levelEducationCode": 1,
			"id": 7,
			"internalId": "1|1|7",
			"code": "00007",
			"name": "Tabela de Preços 7",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

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

}
	]
}

1.2 - POST

...

1.2.1 - Post (Inserir uma tabela de preços)

Expandir

Informações

icon	false
title	Post

A inclusão de uma nova tabela de preços 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 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

title
icon	false

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: 8051Campo 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 ResultadoEntrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNextcompanyCode": false1,
	"itemslevelEducationCode": [
		{
		1,
	"code": "0000100005",
			"name": "Tabela de Precos Umvia Postman",
	"active": false,
	},
		"appliedMatrixes": []
}
ou 
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "0000200005",
			"name": "Tabela de Precos via DoisPostman",
		}
	]
}

1.1.6 - GetOne (Recuperar tabela de preços pelo identificador)

"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ços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"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

Expandir

Informações

icon	false
title	GetOne

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

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 Precos Um",
	"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCodelevelEducationCode": 1,
			"levelEducationCodeid": 125,
			"appliedMatrixCodeinternalId": 132"1|1|25",
			"priceTableCodecode": 3"00007",
			"branchNamename": "FilialTabela Belode HorizontePrecos -via FantasiaPostman",
			"courseCodeactive": "1-1"false,
	"priceTableInUse": false,
			"courseNameappliedMatrixes": "Curso Tabela de Preços"[]
}
ou
{
	"companyCode": 1,
			"curriculumGridCodelevelEducationCode": 1,
	"1id": 12,
			"curriculumGridNameinternalId": "Matriz Tabela de Preços1|1|12",
			"majorCodecode": "100005",
			"majorNamename": "HabilitaçãoTabela de TabelaPrecos devia PreçosPostman",
			"classShiftCodeactive": 11false,
			"classShiftNamepriceTableInUse": false,
	"INTEGRAL",appliedMatrixes": [
		{
			"statuscompanyCode": 01,
			"actionStatebranchCode": 01,
		}
	],
	"termslevelEducationCode": []1,
			"termBranchesappliedMatrixCode": [132,
		{
		"priceTableCode": 12,
			"branchCodebranchName": 1"Filial Belo Horizonte - Fantasia",
		}
	]
}

1.2 - POST

1.2.1 - Post (Inserir uma tabela de preços)

Expandir

Informações

icon	false
title	Post

A inclusão de uma nova tabela de preços 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 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

	"courseCode": "1-1",
			"courseName": "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,
			"actionState": 0
		}
	]
}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Resultado Negativo

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

{
	"companyCodecode": 1null,
	"levelEducationCodemessage": 1,
	"code": "00005",
	"name": "Tabela de Precos via Postman"Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
	"activedetailedMessage": falsenull,
	"appliedMatrixeshelpUrl": []
}
ou 
{
	"companyCode": 1null,
	"levelEducationCodedetails": null
}

1.3 - PUT

...

1.3.1 - Put (Atualização de uma tabela de preços)

Expandir

Informações

icon	false
title	Patch

A atualização da tabela de preços será feita contendo os seus dados e os dados das suas matrizes aplicadas vinculadas, e dos períodos letivos de ingresso. Não sendo possível inserir a tabela de preços 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 Precos via Postman ALT",
	"active": false,
	"appliedMatrixes": [],
	"terms": [1,
	"code": "00005",
	"name": "Tabela de Precos 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ços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"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": 2514,
	    "internalId": "1|1|2514",
	    "code": "0000700003",
	    "name": "Tabela de Precos via Postman ALT",
	    "active": false,
	    "priceTableInUse": false,
	    "appliedMatrixes": []
}
ou
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 12,
	"internalId": "1|1|12",
,
    "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": "00005"null,
	"namemessage": "TabelaNão foi possível incluir/editar a tabela de preços. Código do nível de Precosensino viaestá Postmaninválido.",
	"activedetailedMessage": falsenull,
	"priceTableInUsehelpUrl": falsenull,
	"appliedMatrixesdetails": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 12,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "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,
			"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ços. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

1.3 - PUT

...

null
}

1.4 - DELETE

...

1.4.1 - Delete (Excluir uma tabela de preços)

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ços 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ços, 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	Patch	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 informadaA atualização da tabela de preços será feita contendo os seus dados e os dados das suas matrizes aplicadas vinculadas, e dos períodos letivos de ingresso. Não sendo possível inserir a tabela de preços 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}pricetableappliedmatrixes

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|14pricetableappliedmatrixes

Informações

icon	false
title	Exemplo de EntradaResultado

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 Precos 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 Precos via Postman ALT",
    "active": false,
    "priceTableInUse": false,
    "appliedMatrixes": [],
    "terms": []
}

{
"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ç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": [],
"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

Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"codehasNext": nullfalse,
	"messageitems": "Não foi possível incluir/editar a tabela de preços. 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ços)

[
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "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": [],
			"actionState": 0
		}
	]
}

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.

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}

Expandir

Domínio: localhost

Porta: 8051

internalId: 1|1|20

Url Utilizada: http://localhost:8051

/api/educational/financial/v1/

pricetable/1|1|20

pricetableappliedmatrixes?page={valor1}&pageSize={valor2}

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

Informações

icon	false
title	Exemplo de Resultado Positivo PostmanConfiguração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 5

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?page=1&pageSize=5Obs.: 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ços 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ços, 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": [
{
"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": 1328,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "13-1",
"courseName": "Curso Tabela de PreçosADMINISTRAÇÃO",
"curriculumGridCode": "14",
"curriculumGridName": "Matriz Tabela de Preços2004/1",
"majorCode": "1",
"majorName": "Habilitação Tabela de PreçosCOMÉRCIO EXTERIOR",
"classShiftCode": 112,
"classShiftName": "INTEGRALTARDE",
"status": 0,
"disciplines": [],
"actionState": 0
},
]
}

2.1.2 - Order (Retorna os dados ordenados)

Expandir

Informações

title	Parâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações

icon	false
title	Order (Asc)

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: courseName

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?order=courseName

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": false,
"items": [
{
" {
"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": 13210,
"priceTableCode": 3,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "13-1",
"courseName": "Curso Tabela de PreçosADMINISTRAÇÃO",
"curriculumGridCode": "14",
"curriculumGridName": "Matriz Tabela de Preços2004/1",
"majorCode": "14",
"majorName": "Habilitação Tabela de PreçosRECURSOS HUMANOS",
"classShiftCode": 111,
"classShiftName": "INTEGRALMANHÃ",
"status": 0,
"disciplines": [],
"actionState": 0
},
{
"companyCode": 1,
"branchCode": 1,
"levelEducationCode": 1,
"appliedMatrixCode": 13211,
"priceTableCode": 243,
"branchName": "Filial Belo Horizonte - Fantasia",
"courseCode": "13-1",
"courseName": "Curso Tabela de PreçosADMINISTRAÇÃO",
"curriculumGridCode": "14",
"curriculumGridName": "Matriz Tabela de Preços2004/1",
"majorCode": "14",
"majorName": "Habilitação Tabela de PreçosRECURSOS HUMANOS",
"classShiftCode": 112,
"classShiftName": "INTEGRALTARDE",
"status": 0,
"disciplines": [],
"actionState": 0
},
]
}

Informações

icon	false
title	Order (Desc)

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: courseName

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?order=-courseName

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 Precos 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 Precos Dois",
			"recCreatedOn": "2025-02-04T11:07:16.693-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

2.1.3 - Filter (Resultado filtrado)

{
"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}/

Expandir

Informações

icon	false
title	Filter

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

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ç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": [],
			"actionState": 0
		}
	]
}

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.

2.1.4 - 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.5 - 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 Precos Um"
		},
		{
			"code": "00002",
			"name": "Tabela de Precos Dois"
		}
	]
}

2.1.6 - GetOne (Recuperar matriz aplicada pelo identificador)

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

2.1.5 - GetOne (Recuperar matriz aplicada pelo identificador)

Expandir

Informações

icon	false
title	GetOne

Nessa requisição será retornada a listagem das disciplinas vinculadas à matriz aplicada.

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

Expandir

Informações

icon	false
title	GetOne

Nessa requisição será retornada a listagem das disciplinas vinculadas à matriz aplicada.

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ç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,
    "appliedMatrixCode": 132,
       "periodDescriptionpriceTableCode": "Período 1"3,
            "disciplineName"branchName": "DIREITO PENAL IIFilial Belo Horizonte - Fantasia",
            "actionState"courseCode": "1-1",
    "courseName": "Curso Tabela  }
    ]de Preços",
    "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" . Os valores possíveis para a propriedade "actionState" na tag "disciplines" pode ser:

0: Sem modificação na disciplina
1: Adicionando uma disciplina
2: Removendo uma disciplina
3: Modificando uma disciplina

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,
	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,
	"appliedMatrixCode            "disciplineCode": 132,
	"priceTableCode": 3,
	"branchName": "Filial Belo Horizonte - Fantasia",
	"courseCode": "1-1",
	"courseName": "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": [
		{
			"0001_ES",
            "periodCode": 0,
            "periodDescription": "Período fixo",
            "disciplineName": "Estágio Supervisionado",
            "workload": 8.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|0001_ES001Wal",
			            "companyCode": 1,
			            "priceTableCode": 3,
			            "appliedMatrixCode": 132,
			            "levelEducationCode": 1,
			            "disciplineCode": "0001_ES001Wal",
			            "periodCode": 0,
			            "periodDescription": "Período fixo",
			            "disciplineName": "Estágio6.Wal Supervisionado",
			            "workload": 85.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ç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",
			"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ços. 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ços com o ID informado para exclusão",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

3 - Período Letivo de Ingresso

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

GET
PUT
DELETE

3.1 - GET

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

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

Expandir

Informações

icon	false
title	GetAll

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" . Os valores possíveis para a propriedade "actionState" na tag "disciplines" pode ser:

0: Sem modificação na disciplina
1: Adicionando uma disciplina
2: Removendo uma disciplina
3: Modificando uma disciplina

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

Informações

icon	false
title	Exemplo de ResultadoEntrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

"companyCode": 1,

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

3.1.2 - Order (Retorna os dados ordenados)


	"branchCode": 1,
	"levelEducationCode": 1,
	"appliedMatrixCode": 132,
	"priceTableCode": 3,
	"branchName": "Filial Belo Horizonte - Fantasia",
	"courseCode": "1-1",
	"courseName": "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.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ç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",
			"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ços. 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ços com o ID informado para exclusão",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

3 - Período Letivo de Ingresso

...

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

GET
PUT
DELETE

3.1 - GET

...

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

Expandir

Informações

icon	false
title	GetAll

Expandir

Informações

title	Parâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações

icon	false
title	Order (Asc)

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: termCode

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms?order=termCode

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

{
"hasNext": false,
"items": [
{
"internalId": "1|3|73|1",
"companyCode": 1,
"priceTableCode": 3,
"termId": 73,
"levelEducationCode": 1,
"termCode": "2024/1",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "1|3|74|1",
"companyCode": 1,
"priceTableCode": 3,
"termId": 74,
"levelEducationCode": 1,
"termCode": "2024/2",
"branchCode": 1,
"branchName": "Filial Belo Horizonte - Fantasia"
},
{
"internalId": "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	Order (Desc)

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051Campo: courseName

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?order=-courseNamepricetableterms

Informações

icon	false
title	Exemplo de Resultado

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

}

Expandir

title	Ver resultado JSON...JSON...

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

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

3.1.3 - Filter (Resultado filtrado)

...

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

2.1.5 - 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"
}
]
}

...

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 67

Nova versão 68

Chave

1.1.2 -

Filter (Resultado filtrado)

1.1.3 - Paginação

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

1.1.5 - GetOne (Recuperar tabela de preços pelo identificador)

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

1.2 - POST

1.2.1 - Post (Inserir uma tabela de preços)

1.1.6 - GetOne (Recuperar tabela de preços pelo identificador)

1.2 - POST

1.2.1 - Post (Inserir uma tabela de preços)

1.3 - PUT

1.3.1 - Put (Atualização de uma tabela de preços)

1.3 - PUT

1.4 - DELETE

1.4.1 - Delete (Excluir uma tabela de preços)

2 - Matriz Aplicada

2.1 - GET

2.1.1 - Get All (Recuperar todas as matrizes aplicadas)

2.1.2 - Filter (Resultado filtrado)

1.4 - DELETE

1.4.1 - Delete (Excluir uma tabela de preços)

2.1.3 - Paginação

2 - Matriz Aplicada

2.1 - GET

2.1.1 - Get All (Recuperar todas as matrizes aplicadas)

2.1.2 - Order (Retorna os dados ordenados)

2.1.3 - Filter (Resultado filtrado)

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

2.1.4 - Paginação

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

2.1.6 - GetOne (Recuperar matriz aplicada pelo identificador)

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)

2.2 - PUT

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

3.1.2 - Order (Retorna os dados ordenados)

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.3 - Filter (Resultado filtrado)

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