Sumário

...

Índice

exclude	Sumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API da Tabela de Preços Preço - NÃO PUBLICAR utilizando todos os métodos implementados.

1 - Métodos

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

GET
POST
PUT
DELETE

1.1 - GET

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

E as api's complementares referente às matrizes aplicadas e aos períodos letivos de ingresso associados à tabela de preço. Para a utilização das api's é importante observar a responsabilidade e o papel de cada uma no cadastro e manutenção das informações da tabela de preços.

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

A API da matriz aplicada tem a responsabilidade de 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. E inserir, alterar e remover os dados das disciplinas vinculadas à matriz aplicada. Nessa api não será possível inserir uma nova matriz aplicada na tabela de preço, essa responsabilidade está na api da tabela de preço.

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

1 - Tabela de Preço

...

Serão apresentados 5 métodos, os quais foram implementados na API da Tabela de Preç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ç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

Informações

icon	false

Retornará todas as tabela de preços sem as listagens das matrizes aplicadas, períodos letivos e filiais dos períodos letivos por questão de performance. Essas informações serão retornadas com a utilização do GetOne para uma tabela de preço específica.

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

Preco",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

1.1.2 -

...

Filter (Resultado filtrado)

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

Expandir

Order (Asc)

Informações

title
icon	false

Filter

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

order

{campo}={

campo

valor}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo:

name

code

Tipo de Ordenação

Valor:

Ascendente

00001

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

order

code=

name

00001

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",

 de Preco 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ç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

Order (Desc)

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

title
icon	false

Paginação

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

order=-{campo

page={valor1}&pageSize={valor2}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo

Valor1:

name

1

Tipo de Ordenação

Valor2:

Descendente

5

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

order=-name

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":

false

true,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de

Precos

Preco 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

Preco Dois",
			"recCreatedOn": "2025-02-04T11:07:16.693-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},

] }

1.1.3 - Filter (Resultado filtrado)

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

	{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 5,
			"internalId": "1|1|5",
			"code": "00005",
			"name": "Tabela de Preço 5",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"

items

priceTableInUse":

[

false,

{

companyCode

appliedMatrixes":

1

[],
			"

levelEducationCode

terms":

1

[],
			"

id

termBranches":

3,

[]
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 6,
			"internalId": "1|1|

3

6",
			"code": "

00001

00006",
			"name": "Tabela de

Precos

Preço

Um

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

01

36:

30

13.

617

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

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

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

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

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":

true

false,
	"items": [
		{
			"

companyCode

code":

1, "levelEducationCode": 1

"00001",
			"

id

name":

3, "internalId": "1|1|3", "code": "00001", "name": "

"Tabela de

Precos

Preco Um"

,

"recCreatedOn": "2025-02-04T11:01:30.617-03:00"

},

"active": false,

{
			"

priceTableInUse

code":

false, "appliedMatrixes": []

"00002",
			"

terms

name":

[], "termBranches": []

"Tabela de Preco Dois"
		}

,

{ "companyCode": 1, "levelEducationCode": 1, "id": 4, "internalId": "1|1|4", "code": "00002", "

]
}

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

Precos

Preco

Dois

Um",

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

07

01:

16

30.

693

617-03:00",

"active": false,

"priceTableInUse": false,

"appliedMatrixes": [

],


		{
			"

terms

companyCode":

[]

1,
			"

termBranches

branchCode":

[] }

1,

{

companyCode

levelEducationCode": 1,
			"

levelEducationCode

appliedMatrixCode":

1

132,
			"

id

priceTableCode":

5

3,
			"

internalId

branchName": "

1|1|5

Filial Belo Horizonte - Fantasia",
			"

code

courseCode": "

00005

1-1",
			"

name

courseName": "Curso Tabela de

Preços 5

Preço",
			"

recCreatedOn

curriculumGridCode": "

2025-02-04T11:36:13.33-03:00

1",
			"

active

curriculumGridName":

false

 "Matriz Tabela de Preço",
			"

priceTableInUse

majorCode":

false

"1",
			"

appliedMatrixes

majorName":

[]

"Habilitação  Tabela de Preço",
			"

terms

classShiftCode":

[]

11,
			"

termBranches

classShiftName":

[] }

"INTEGRAL",

{

companyCode

status":

1

0,
			"

levelEducationCode

actionState":

1,

"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": [

] },


		{
			"

companyCode

branchCode": 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)

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

}
	]
}

1.2 - POST

...

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

Expandir

Informações

icon	false
title	Post

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

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

Informações

icon	false
title	GetOne

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

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

Resultado

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

Domínio: localhost

Porta: 8051

internalId: 1|1|3

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

Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"

hasNext

companyCode":

false

1,
	"

items

levelEducationCode":

[ {

1,
	"code": "

00001

00005",

"name": "Tabela de

Precos

Preco via

Um

Postman",
	"active": false,

},

"appliedMatrixes": []
}
ou 
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "

00002

00005",

"name": "Tabela de

Precos

Preco via

Dois

Postman",

} ] }

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

3

25,
	"internalId": "1|1|

3

25",
	"code": "

00001

00007",
	"name": "Tabela de

Precos Um"

 Preco via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": []
}
ou
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"

recCreatedOn

id":

"2025-02-04T11:01:30.617-03:00

12,
	"internalId": "1|1|12",
	"code": "00005",
	"name": "Tabela de Preco via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode":

3

12,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de

Preços

Preço",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de

Preços

Preço",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de

Preços

Preço",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	]

, "terms": [], "termBranches": [ { "branchCode": 1 } ]

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

title
icon	false

Post

Patch

A atualização da tabela de 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ço com suas matrizes aplicadas contendo suas disciplinas. Essas informações serão inseridas em outras api's com essa responsabilidade.

Máscara de

Máscara de

Url: http://{domínio}:{porta}/api/educational/financial/v1/

prospection

pricetable/

prospections

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

prospection/prospections

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":

"description

1,
	"id": 14,
	"internalId": "

Nova prospecção 2024

1|1|14",

"prospects

	"code": "00003",
	"name": "Tabela de Preco 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,
    "

prospectName

levelEducationCode":

"

,
    "id": 14,

prospectType

internalId": "

A

1|1|14",

"candidateUserCode

"code":

198

"00003",
    "name": "Tabela de Preco via Postman ALT",
    "

companyCode

active":

1

false,
    "priceTableInUse": false,

studentCode

appliedMatrixes":

"ES-00219"

[],

prospectPaymentPlans

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ç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ç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ç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ço",
"curriculumGridCode": "1",
"curriculumGridName": "Matriz Tabela de Preço",
"majorCode": "1",
"majorName": "Habilitação Tabela de Preç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ço",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preço",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preço",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"disciplines": [],
			"actionState": 0
		}
	]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API da 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 Preco Um"
		},
		{
			"code": "00002",
			"name": "Tabela de Preco 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ço",
    "curriculumGridCode": "1",
    "curriculumGridName": "Matriz Tabela de Preço",
    "majorCode": "1",
    "majorName": "Habilitação  Tabela de Preç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ço",
	"curriculumGridCode": "1",
	"curriculumGridName": "Matriz Tabela de Preço",
	"majorCode": "1",
	"majorName": "Habilitação  Tabela de Preç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ço",
	"curriculumGridCode": "1",
	"curriculumGridName": "Matriz Tabela de Preço",
	"majorCode": "1",
	"majorName": "Habilitação  Tabela de Preç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ç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ç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ç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 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ç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

Positivo

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
}

{ "companyCode": 1, "termCode": 32, "termCodeDescription": "2023/1", "paymentPlanCode": "2.0", "levelEducationCode": 1, "paymentPlanName": "Plano 2", "branchCode": 1 } ], "prospectScholarShips": [ { "companyCode": 1, "scholarShipCode": "1", "scholarShipName": "FUNCIONÁRIO DA ESCOLA", "levelEducationCode": 1, "serviceCode": "1", "serviceName": "MENSALIDADE", "termCode": 32, "termCodeDescription": "2023/1", "discountType": "P", "discountValue": 25.1234, "startDate": "2023-01-01T00:00:00-03:00", "endDate": "2023-12-31T00:00:00-03:00", "validityType": "T", "branchCode": 1 } ] }, { "prospectName": "2", "prospectType": "C", "candidateUserCode": 212, "companyCode": 1, "prospectPaymentPlans": [ { "companyCode": 1, "termCode": 32, "termCodeDescription": "2023/1", "paymentPlanCode": "2023/PS", "levelEducationCode": 1, "paymentPlanName": "2023 Processo seletivo teste", "branchCode": 1 } ], "prospectScholarShips": [] }, { "prospectName": "AAAA sss", "prospectType": "P", "individualRegistrationCode": "45657746589", "prospectPaymentPlans": [ { "companyCode": 1, "termCode": 28, "termCodeDescription": "2021", "paymentPlanCode": "10112690", "levelEducationCode": 2, "paymentPlanName": "Plano 1 - Padrão 11 parcelas", "branchCode": 1 } ], "prospectScholarShips": [ { "companyCode": 1, "scholarShipCode": "13", "scholarShipName": "DIRETORIA", "levelEducationCode": 2, "serviceCode": "27", "serviceName": "Mensalidade", "termCode": 32, "termCodeDescription": "2021", "discountType": "P", "discountValue": 11.0000, "validityType": "P", "startInstallment": 1, "endInstallment": 1, "branchCode": 1 } ] }, { "prospectName": "Antonio Lucas Peixoto", "prospectType": "A", "companyCode": 1, "studentCode": "EB-00238", "prospectPaymentPlans": [ { "companyCode": 1, "termCode": 23, "termCodeDescription": "2019", "paymentPlanCode": "2019-12x", "levelEducationCode": 2, "paymentPlanName": "12 parcelas", "branchCode": 1 } ], "prospectScholarShips": [] } ] }

Informações

icon	false
title	Exemplo de Resultado

com sucesso (201 - Created)

Expandir

title	Ver resultado JSON...

Bloco de código

linenumbers
language	js
firstline	1
title	Resultado (JSON)

	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": [

true

{ "prospectionCode": 5, "description": "Nova prospecção 2024", "prospects": [ { "prospectionCode": 5, "prospectCode": 137, "prospectName": "1", "prospectType": "A", "candidateUserCode": 198, "companyCode": 1, "studentCode": "ES-00219", "prospectPaymentPlans": [ { "prospectionCode": 5, "prospectCode": 137, "prospectPaymentPlanCode": 114, "companyCode": 1, "termCode": 32, "termCodeDescription": "2023/1", "paymentPlanCode": "2.0", "levelEducationCode": 1, "paymentPlanName": "Plano 2", "branchCode": 1 } ], "prospectScholarShips": [ { "prospectionCode": 5, "prospectCode": 137, "prospectSchoolshipCode": 86, "companyCode": 1, "scholarShipCode": "1", "scholarShipName": "FUNCIONÁRIO DA ESCOLA", "levelEducationCode": 1, "serviceCode": "1", "serviceName": "MENSALIDADE", "termCode": 32, "termCodeDescription": "2023/1", "discountType": "P", "discountValue": 25.1234, "startDate": "2023-01-01T00:00:00-03:00", "endDate": "2023-12-31T00:00:00-03:00", "validityType": "T", "branchCode": 1 } ] },


        {
            "

prospectionCode

companyCode":

5

1,
            "

prospectCode

levelEducationCode":

138

1,
            "

prospectName

id":

"2"

23,
            "

prospectType

internalId": "

C

1|1|23",

"candidateUserCode": 212,

companyCode

active":

1

true,
            "

prospectPaymentPlans

statusFillDisciplines":

[

1,

{

prospectionCode

terms":

5,

"prospectCode": 138,

{
                    "

prospectPaymentPlanCode

companyCode":

115

1,
                    "

companyCode

priceTableCode":

1

23,
                    "

termCode

termId":

32

75,
                    "

termCodeDescription

levelEducationCode":

"2023/

"

,
                    "

paymentPlanCode

termCode": "

2023

2025/

PS

1",
                    "

levelEducationCode

branchCode": 1

,

"paymentPlanName": "2023 Processo seletivo teste",

},

"branchCode":

1

}

           "companyCode":

]

1,

"prospectScholarShips":

[]

       "priceTableCode":

}

23,

{

prospectionCode

termId":

5

78,

"prospectCode":

139,

     "levelEducationCode": 1,

"prospectName":

"AAAA

sss",

prospectType

termCode": "

P

202522",
                    "

individualRegistrationCode

branchCode":

"45657746589",

"prospectPaymentPlans":

[

}
            ]

{

  
        },
        {

"prospectionCode":

5,

       "companyCode": 1,
            "

prospectCode

levelEducationCode":

139

1,
            "id": 24,
            "

prospectPaymentPlanCode

internalId":

116,

"1|1|24",            
            "

companyCode

active":

1

true,
            "statusFillDisciplines": 1,
            "

termCode

priceTableInUse":

28

false,

termCodeDescription

terms":

"2021",

"paymentPlanCode": "10112690",

{
                    "

levelEducationCode

companyCode":

2

1,

"paymentPlanName": "Plano 1 - Padrão 11 parcelas"

 "priceTableCode": 24,
                    "

branchCode

termId":

1

75,

}

    "levelEducationCode": 1,

],

prospectScholarShips

termCode":

[

"2025/1",

{

   "branchCode": 1

"prospectionCode":

5,

"prospectCode":

139,

"prospectSchoolshipCode":

87,


        }
    ]
}

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,

"scholarShipCode

"priceTables":

"13",

[
        {
            "

scholarShipName

companyCode":

"DIRETORIA"

1,

"levelEducationCode":

2

1,
            "id": 23,
            "

serviceCode

code": "

27

ENG SOF 2009",

"serviceName

"name": "

Mensalidade

ENGENHARIA DE SOFTWARE",

"termCode

"statusFillDisciplines":

32

0,

termCodeDescription

terms":

"2021",

"discountType": "P",

{
                    "

discountValue

companyCode":

11.0000

1,
                    "

validityType

priceTableCode":

"P"

23,
                    "

startInstallment

termId":

1

75,
                    "

endInstallment

levelEducationCode": 1,
                    "branchCode": 1
                },

]

},

{

prospectionCode

companyCode":

5

1,

"prospectCode":

140,

prospectName

priceTableCode":

"Antonio Lucas Peixoto"

23,

"prospectType":

"A",

companyCode

termId":

1

78,

"studentCode":

"EB-00238",

prospectPaymentPlans

levelEducationCode":

[

1,

{

    "branchCode": 2

"prospectionCode": 5,

 }
            ]

"prospectCode": 140

},
        {
            "

prospectPaymentPlanCode

companyCode":

117

1,

"companyCode

"levelEducationCode": 1,
            "id": 24,

"termCode": 23,

       "code": "TSTRjs",
            "

termCodeDescription

name": "

2019

Teste reajuste",
            "statusFillDisciplines": 0,

"paymentPlanCode":

"2019-12x",

    "terms": [

"levelEducationCode": 2,

 {
                    "

paymentPlanName

companyCode":

"12 parcelas"

1,
                    "

branchCode

priceTableCode":

1

24,

}

   "termId": 75,

],

prospectScholarShips

levelEducationCode":

[]

1,

}

] }

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

branchCode":

null,

"message":

"A

bolsa

12

já

está

cadastrada

para

o

prospect

'1'

na

prospecção

'Matricula

de

ingressantes

2022'.\r\nA

bolsa

20

já

está

cadastrada

para

o

prospect

'AAAA

sss'

na

prospecção

'Matricula

de

ingressantes

2022'.",

"detailedMessage": null

],
    "

helpUrl

readjustmentPercent":

null

50.0,
    "

details

observation":

null

 "Teste de reajuste"
}

1.3 - PUT

...

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.

Patch

Expandir

Informações

title
icon	false

Post

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

educational

framework/v1/

prospection/prospections/{prospectionCode} de Entrada de Resultado Positivo

jobscheduler

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta:

8051

prospectionCode: 3

Url Utilizada:

http://localhost:8051/api/

educational

framework/v1/

prospection/prospections/3

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

"prospects": [

{ "prospectName

"processID": "

Tomás Augusto

EduVinculaTabelaPrecoMatrizAplicadaData",

prospectType

firstExecution": "

A", "companyCode": 1

2025-02-17T18:12:00-03:00",

studentCode

recurrent":

"ES-00219"

false,

prospectPaymentPlans

executionParameter":

[

{
        "Context": {

{

"companyCode":

1,

"termCode":

32,

"paymentPlanCode":

"2.0",

"levelEducationCode":

1,

branchCode

_params":

1 },

{

"companyCode":

1,

"termCode":

32,

paymentPlanCode

$CODCOLIGADA":

"2023/PS", "levelEducationCode":

1,

"branchCode": 1 }

],

prospectScholarShips

$CODFILIAL":

[

1,

{

    "$CODTIPOCURSO": 1,
                "

companyCode

$CODUSUARIO":

1

"mestre",

scholarShipCode

$CODSISTEMA":

"10",

"S"

"levelEducationCode": 1,

}
        },
        "

serviceCode

ProcessName": "

1

Vinculo Matriz Aplicada e Campus/Polo",

       "UserName": "mestre",
        "

termCode

PrimaryKeyList": [

32,

"discountType":

"P",

"discountValue":

90.0000,

"startDate":

"2024-01-05T00:00:00-03:00",

"endDate":

"2024-01-29T00:00:00-03:00",

"validityType":

"T",

branchCode": 1

1|1|6"
            ]

},

],

{

 "PrimaryKeyNames": [

companyCode

internalId"

: 1,


        ],
        "

scholarShipCode

HostName": "

12

HOST",

"levelEducationCode

"appliedMatrixCodeList":

1,

[
            21,

"serviceCode":

"2",

25,

"termCode":

10,

 26
        ],
        "

discountType

appliedMatrixCampusCodeList":

"P", "discountValue": 2.0000, "startDate": "2024-01-05T00:00:00-03:00", "endDate": "2024-01-29T00:00:00-03:00", "validityType": "T", "branchCode": 1

[
            "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

{
    "

prospectionCode

processID":

3, "description": "Duplicação", "prospects": [ {

"EduVinculaTabelaPrecoMatrizAplicadaData",
    "

prospectionCode

recurrent":

3

false,
    "executionParameter": {
        "

prospectCode

Context":

141,

{
            "

prospectName

_params":

"Tomás Augusto",

{
                "

prospectType

$CODCOLIGADA":

"A"

1,
                "

companyCode

$CODFILIAL": 1,
                "

studentCode

$CODTIPOCURSO":

"ES-00219"

1,
                "

prospectPaymentPlans

$CODUSUARIO":

[

"mestre",

{

"$CODSISTEMA": "S"
            }

"prospectionCode": 3

},
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "

prospectCode

UserName":

141

"mestre",
        "PrimaryKeyList": [

"prospectPaymentPlanCode": 118,

 [
                "1|1|6"

"companyCode":

1,

    ]
        ],
        "

termCode

PrimaryKeyNames":

32,

[
            "internalId"

"paymentPlanCode": "2.0"

],

"HostName": "HOST",
        "

levelEducationCode

appliedMatrixCodeList":

1,

[
            21,

"branchCode":

1

25,

},

26
        ],

{

"appliedMatrixCampusCodeList": [
            "21|1",

"prospectionCode":

3,

   "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

prospectCode

jobScheduleId":

141

"105783",

"status": "active",

"prospectPaymentPlanCode

"lastModified":

119

"2025-02-17T18:40:27-03:00",

"companyCode

"processId":

1

"EduVinculaTabelaPrecoMatrizAplicadaData",

"termCode": 32, "paymentPlanCode": "2023/PS",

"firstExecution": "2025-02-17T18:40:00-03:00",
    "user": "mestre",
    "

levelEducationCode

recurrent":

1

false,
    "executionParameter": {

"branchCode

"appliedMatrixCodeList":

1

}

21,

]

25,

"prospectScholarShips": [

26
        ],
        "appliedMatrixCampusCodeList":

{

[
            "21|1",

"prospectionCode":

3,

   "25|1"
        ],

prospectCode

CodColigada":

141

0,
        "CodFilial": 0,

prospectSchoolshipCode

CodTipoCurso":

88

0,
        "Initialized": false,

companyCode

PrimaryKeyList":

1,

[
            [

"scholarShipCode":

"10",

       "1|1|6"

"levelEducationCode": 1,

],
        "

serviceCode

PrimaryKeyNames":

"1",

[
            "internalId"

"termCode": 32

],

"PrimaryKeyTableName": null,

discountType

OnlineMode":

"P"

false,

"SyncExecution": false,
        "

discountValue

HideProgressDialog":

90.0000

false,
        "SaveParamsExecution": false,

startDate

CodUsuario": "

2024-01-05T00:00:00-03:00

mestre",
        "Context": {
            "

endDate

$id": "

2024-01-29T00:00:00-03:00

1",

validityType

_params":

"T",

{
                "

branchCode

$CODFILIAL": 1,

}

"$CODSISTEMA": "S",

{

"$CODCOLIGADA": 1,

prospectionCode

$CODUSUARIO":

3

"mestre",
                "$CODTIPOCURSO": 1

"prospectCode":

141,

        },
            "

prospectSchoolshipCode

Environment":

89,

},

companyCode

UserName":

1

"mestre",

"ConnectionId": null,

scholarShipCode

ConnectionString":

"12"

null,

"DriverType": null,

levelEducationCode

Ip":

1

null,
        "HostName": "",

serviceCode

JobServerHostName": "

2

BHN050104619",
        "ActionName": null,
        "MasterActionName": null,
        "

termCode

ActionModule":

10

null,
        "JobID": {
            "

discountType

ID":

"P"

105783,

     "ExecID": 1,
            "

discountValue

IsPriorityJob":

2.0000

false,
            "Children": []

"startDate": "2024-01-05T00:00:00-03:00"

},

"ShowReExecuteButton": true,
        "

endDate

ExecutionId": "

2024

f414352f-fe43-

01-29T00:00:00-03:00

444c-a437-80cb6390388e",
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "

validityType

ServerName":

"T"

null,
        "ServiceInterface": null,
        "Scheduler": 1,
        "

branchCode

UseJobMonitor":

1

true,
        "ScheduleDateTime": "2025-02-17T18:40:26-03:00",

}

"CanSendMail": false,

]

"CanWaitSchedule": false,

}

"SendMail": false,

] }

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

FriendlyLogs": null,
        "

message

SuccessMessage": "

A

Processo

bolsa

executado

10 já está cadastrada para o prospect 'Tomás Augusto' na prospecção 'Duplicação'.\r\nA bolsa 12 já está cadastrada para o prospect 'Tomás Augusto' na prospecção 'Duplicação'.",

com sucesso",
        "FailureMessage": "Falha na execução do processo",
        "SaveLogInDatabase": true,
        "

detailedMessage

StatusMessage": null,
        "

helpUrl

WaitSchedule":

null

false,
        "

details

IsolateProcess":

null }

1.4 - DELETE

1.4.1 - Delete (Exclui uma Prospecção)

Informações

icon	false
title	Delete

Máscara de Url: http://{domínio}:{porta}/api/educational/v1/prospection/prospections/{prospectionCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

prospectionCode: 5

Url Utilizada: http://localhost:8051/api/educational/v1/prospection/prospections/5

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

Informações

icon	false
title	Delete

Máscara de Url: http://{domínio}:{porta}/api/educational/v1/prospection/prospect/{prospectionCode}|{prospectCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

prospectionCode: 3

prospectCode: 141

Url Utilizada: http://localhost:8051/api/educational/v1/prospection/prospect/3|141

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.

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{ "code

false,
        "DisableIsolateProcess": false,
        "NetworkUser": "",
        "CustomData": null,
        "

message

CanParallelize":

"O

false,

código

da

prospecção

não

foi

informado

ou

é inválido."

"ShouldParallelize": false,
        "

detailedMessage

QuantityOfSplits":

null

0,
        "

helpUrl

MinimumQuantityOfPrimaryKeysPerProcess":

null

1,
        "

details

MaximumQuantityOfPrimaryKeysPerProcess":

null }

1.4.2 - Delete (Exclui um Prospect da Prospecção)

Resultado Negativo

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

Code":

null

"FE016",
    "

message

Message": "O

id

corpo

do

da

prospect

mensagem

não

contém

foi informado ou é inválido

valores inválidos.",
    "

detailedMessage

DetailMessage":

null

"",
    "HelpUrl":

"helpUrl": null

"http://tdn.totvs.com/x/e0F0GQ",
    "

details

Details": null
}

1.4.3 - Delete (Exclui um Plano de Pagamento do Prospect da Prospecção)

Informações

icon	false
title	Delete

Máscara de Url: http://{domínio}:{porta}/api/educational/v1/prospect/paymentplan/{prospectionCode}|{prospectCode}|{prospectPaymentPlanCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

prospectionCode: 3

prospectCode: 133

prospectPaymentPlanCode: 101

Url Utilizada: http://localhost:8051/api/educational/v1/prospect/paymentplan/3|133|101

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": "O id do plano de pagamento do prospect não foi informado ou é inválido",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

1.4.4 - Delete (Exclui uma Bolsa do Prospect da Prospecção)

Informações

icon	false
title	Delete

Máscara de Url: http://{domínio}:{porta}/api/educational/v1/prospect/scholarship/{prospectionCode}|{prospectCode}|{prospectSchoolshipCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

prospectionCode: 3

prospectCode: 128

prospectSchoolshipCode: 80

Url Utilizada: http://localhost:8051/api/educational/v1/prospect/scholarship/3|128|80

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": "O id da bolsa do prospect não foi informado ou é inválido",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

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

Prospeção

prospectionCode: Código da prospecção
description: Descrição da prospecção
prospects: Lista de prospects da prospecção

Prospects

prospectionCode: Código da prospecção
prospectCode: Código do prospect
prospectName: Nome do prospect
prospectType: Tipo do prospect (A = "aluno", C = "candidato" ou P = "pessoa")
companyCode: Código da coligada
studentCode: Registro acadêmico do aluno
prospectPaymentPlans: Lista de planos de pagamento do prospect
prospectScholarShips: Lista bolsas do prospect

Planos de pagamento do prospect

prospectionCode: Código da prospecção
prospectCode: Código do prospect
prospectPaymentPlanCode: Código do plano de pagamento do prospect
companyCode: Código da coligada
termCode: Código do período letivo
paymentPlanCode: Código do plano de pagamento
levelEducationCode: Código do nível de ensino
branchCode: Código da filial

Bolsas do prospect

...

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
levelEducationCode: Código do nível de ensino/tipo de curso
internalId: Identificador da 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 à Matriz Aplicada

companyCode: Código da coligada
priceTableCode: Identificador da tabela de preç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ço|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ç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

...

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 - GET

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

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.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ço 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ço)

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

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)

1.3 - PUT

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

1.4 - DELETE

1.4.1 - Delete (Exclui uma Prospecção)

1.4.2 - Delete (Exclui um Prospect da Prospecção)

1.4.3 - Delete (Exclui um Plano de Pagamento do Prospect da Prospecção)

1.4.4 - Delete (Exclui uma Bolsa do Prospect da Prospecção)

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

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