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)

Informações

icon	false
title	GetAll

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 - Order (Retorna os dados ordenados)

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

. 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	Order (Asc)

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

?order={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name

Tipo de Ordenação: Ascendente

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

?order=name

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

title
language	js
firstline	1

{

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

 Preco",
			"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.2 - Filter (Resultado filtrado)

icon

Expandir

Informações

icon	false
title	Filter

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Valor: 00001

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNext": false,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",


			"code": "00001",


			"name": "Tabela de

Precos

 Preco Um",


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


			"active": false,


			"priceTableInUse": false,


			"appliedMatrixes": [],


			"terms": [],


			"termBranches": []

}
]


		}
	]
}

Informações

false

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

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}

Order (Desc)

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": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,

] }

1.1.3 - Filter (Resultado filtrado)

Informações

icon	false
title	Filter

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: bankNumber

Valor: 005

Url Utilizada: http://localhost:8051/api/educational/v1/prospection/prospections?prospectionCode=2

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": [
        {
            "prospectionCode": 2,
            "description": "Prospecção 2024 - Novo Curso",
            "prospects": []
        }
    ]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API de Prospecçã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.4 - Paginação

			"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,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 6,
			"internalId": "1|1|6",
			"code": "00006",
			"name": "Tabela de Preço 6",
			"recCreatedOn": "2025-02-04T11:36:13.33-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 7,
			"internalId": "1|1|7",
			"code": "00007",
			"name": "Tabela de Preç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)

Paginação

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

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

Fields

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

prospection/prospections

pricetable?

page

fields={

valor1}&pageSize={valor2

campos}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1

Campo 1:

1

code

Valor2

Campo 2:

2

name

Url Utilizada:

http://localhost:8051/api/educational/financial/v1/

prospection/prospections

pricetable?

page=1&pageSize=1

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

{ "prospectionCode": 1, "description

		{
			"code": "00001",
			"name": "

Matricula

Tabela de

ingressantes

Preco

2022

Um"

, "prospects": [] }


		},
		{
			"code": "00002",
			"name": "Tabela de Preco Dois"
		}
	]
}

1.1.5 -

...

GetOne (

...

Recuperar tabela de preço pelo identificador)

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

Expandir

Fields

Informações

title
icon	false

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/

prospection

pricetable/

prospections?fields=

{

campos

internalId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta:

8051

Campo 1: prospectionCode

Campo 2: description

8051

internalId: 1|1|3

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

prospection/prospections?fields=prospectionCode,description

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

"hasNext

	"companyCode":

false

1,

"items

	"levelEducationCode":

[ { "prospectionCode": 1, "description": "Matricula de ingressantes 2022" }, { "prospectionCode": 2, "description": "Prospecção 2024 - Novo Curso" }, { "prospectionCode": 3, "description": "Duplicação" } ] }

1.1.6 - GetOne (Recuperar prospecção pelo identificador)

1,
	"id": 3,
	"internalId": "1|1|3",
	"code": "00001",
	"name": "Tabela de Preco Um",
	"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preç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
		}
	],
	"terms": [],
	"termBranches": [
		{
			"branchCode": 1
		}
	]
}

1.2 - POST

...

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

Expandir

Informações

icon	false
title	Post

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

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Informações

icon	false
title	GetOne

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

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title

Expandir

title

Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

"prospectionCode

	"companyCode": 1,
	"levelEducationCode": 1,

"description

	"code": "00005",
	"name": "

Matricula

Tabela de

ingressantes

Preco via

2022

Postman",

"prospects

	"active": false,
	"appliedMatrixes": []
}

{ "prospectionCode

ou 
{
	"companyCode": 1,

"prospectCode

	"levelEducationCode":

91

1,

"prospectName

	"code": "

1

00005",
	"name": "Tabela de Preco

"prospectType

via Postman",
	"active":

"A"

false,
	"appliedMatrixes":

"candidateUserCode": 198, "companyCode

[
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte

"studentCode

- Fantasia",
			"courseCode": "

ES

1-

00219

1",
			"courseName": "Curso Tabela

"prospectPaymentPlans

de Preço",
			"curriculumGridCode":

[ { "prospectionCode": 1, "prospectCode": 91, "prospectPaymentPlanCode": 77, "companyCode": 1, "termCode": 32, "termCodeDescription": "2023/1", "paymentPlanCode": "2.0",

"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": 25,
	"internalId": "1|1|25",
	"code": "00007",
	"name": "Tabela de Preco via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": []
}
ou
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id":

"paymentPlanName

12,
	"internalId": "1|1|12",
	"code": "

Plano 2

00005",
	"name": "Tabela de Preco

via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,

} ], "prospectScholarShips": [ { "prospectionCode": 1, "prospectCode": 91, "prospectSchoolshipCode": 45, "companyCode": 1, "scholarShipCode": "12", "scholarShipName": "SINDICATO", "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": 1, "prospectCode": 92, "prospectName": "2", "prospectType": "C", "candidateUserCode": 212, "companyCode": 1, "prospectPaymentPlans": [ { "prospectionCode": 1, "prospectCode": 92, "prospectPaymentPlanCode": 78, "companyCode": 1, "termCode": 32, "termCodeDescription": "2023/1", "paymentPlanCode": "2023/PS", "levelEducationCode": 1, "paymentPlanName": "2023 Processo seletivo teste", "branchCode": 1 } ], "prospectScholarShips": [] }, { "prospectionCode": 1, "prospectCode": 93, "prospectName": "AAAA sss", "prospectType": "P", "individualRegistrationCode": "45657746589", "prospectPaymentPlans": [ { "prospectionCode": 1, "prospectCode": 93, "prospectPaymentPlanCode": 79, "companyCode": 1, "termCode": 28, "termCodeDescription": "2021", "paymentPlanCode": "10112690", "levelEducationCode": 2, "paymentPlanName": "Plano 1 - Padrão 11 parcelas", "branchCode": 1 } ], "prospectScholarShips": [ { "prospectionCode": 1, "prospectCode": 93, "prospectSchoolshipCode": 46, "companyCode": 1, "scholarShipCode": "20", "scholarShipName": "Bolsa teste 1", "levelEducationCode": 2, "serviceCode": "27", "serviceName": "Mensalidade", "termCode": 28, "termCodeDescription": "2021", "discountType": "P", "discountValue": 11.0000, "validityType": "P", "startInstallment": 1, "endInstallment": 1, "branchCode": 1 } ] }, { "prospectionCode": 1, "prospectCode": 94, "prospectName": "Antonio Lucas Peixoto", "prospectType": "A", "companyCode": 1, "studentCode": "EB-00238", "prospectPaymentPlans": [ { "prospectionCode": 1, "prospectCode": 94, "prospectPaymentPlanCode": 80, "companyCode": 1, "termCode": 23, "termCodeDescription": "2019", "paymentPlanCode": "2019-12x", "levelEducationCode": 2, "paymentPlanName": "12 parcelas", "branchCode": 1 } ], "prospectScholarShips": [] } ] }

1.2 - POST

1.2.1 - Post (Inserir uma Prospecção)

			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 12,
			"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 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

icon	false
title	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 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 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,
    "levelEducationCode": 1,
    "id": 14,
    "internalId": "1|1|14",
    "code": "00003",
    "name": "Tabela de Preco via Postman ALT",
    "active": false,
    "priceTableInUse": false,
    "appliedMatrixes": [],
    "terms": []
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"code": null,
	"message": "Não foi possível incluir/editar a tabela de preç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)

Resultado Positivo

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	Post

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

{ "description": "Nova prospecção 2024", "prospects": [ { "prospectName": "1", "prospectType": "A", "candidateUserCode": 198, "companyCode": 1, "studentCode": "ES-00219", "prospectPaymentPlans": [ { "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 Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Expandir

title	Ver resultado JSON...

Bloco de código

language

js

firstline

1

title

Resultado (JSON)

Bloco de código

language	js
firstline	1
title	Resultado (JSON)

linenumbers	true

{
    "

prospectionCode

companyCode":

5

1,
    "

description

branchCode":

"Nova prospecção 2024"

1,
    "

prospects

levelEducationCode":

[

1,

{

"appliedMatrixCode": 132,
    "

prospectionCode

priceTableCode":

5

3,
    "branchName": "Filial Belo Horizonte - Fantasia",
    "

prospectCode

courseCode":

137

"1-1",
    "courseName": "Curso Tabela de Preço",
    "

prospectName

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

prospectType

majorCode": "

A

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

candidateUserCode

classShiftCode":

198

11,
    "classShiftName": "INTEGRAL",

companyCode

status":

1

0,
    "disciplines": [

"studentCode": "ES-00219",

 {
            "

prospectPaymentPlans

internalId":

[

"1|3|132|1|0001_ES",
            "companyCode": 1,

{

       "priceTableCode": 3,
            "

prospectionCode

appliedMatrixCode":

5

132,

"prospectCode

"levelEducationCode":

137

1,

prospectPaymentPlanCode

disciplineCode":

114

"0001_ES",

"companyCode

"periodCode":

1

0,
            "periodDescription":

"termCode": 32,

"Período fixo",

termCodeDescription

disciplineName": "

2023/1

Estágio Supervisionado",

paymentPlanCode

workload":

"2

8.

0"

0000,
            "actionState": 1

"levelEducationCode":

1

},
        {
            "

paymentPlanName

internalId": "

Plano 2

1|3|132|1|001Wal",

branchCode

companyCode": 1,
            "priceTableCode": 3,

}

]

"appliedMatrixCode": 132,
            "

prospectScholarShips

levelEducationCode":

[

1,
            "disciplineCode": "001Wal",

{

         "periodCode": 0,
            "

prospectionCode

periodDescription":

5

"Período fixo",

"prospectCode": 137,

"disciplineName": "6.Wal ",

prospectSchoolshipCode

workload":

86

5.0000,
            "actionState": 1

"companyCode":

1

},
        {
            "

scholarShipCode

internalId": "1|3|132|1|146-1",
            "companyCode": 1,
            "

scholarShipName

priceTableCode":

"FUNCIONÁRIO DA ESCOLA",

3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,

serviceCode

disciplineCode": "146-1",
            "periodCode": 1,
            "

serviceName

periodDescription": "

MENSALIDADE

Período 1",
            "disciplineName": "7.DIREITO COMERCIAL I",

"termCode

       "workload":

32

50.0000,
            "actionState": 1

"termCodeDescription": "2023/1"

 },
        {
            "

discountType

internalId": "

P

1|3|132|1|147-1",
            "companyCode": 1,
            "

discountValue

priceTableCode":

25.1234

3,
            "appliedMatrixCode": 132,
            "

startDate

levelEducationCode":

"2023-01-01T00:00:00-03:00"

1,

"endDate

"disciplineCode": "

2023-12-31T00:00:00-03:00

147-1",
            "periodCode": 1,
            "

validityType

periodDescription": "

T

Período 1",

"branchCode

"disciplineName":

1

"DIREITO COMERIAL II",

}

"workload": 50.0000,
            "actionState": 1
        },
        {
            "internalId":

] }, { "prospectionCode": 5,

"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

Informações

icon	false
title	POST

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

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

4.3 - Processar reajuste de valores

...

4.3.1 - POST (Processa reajuste de valores)

Expandir

Informações

icon	false
title	POST

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

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCode": 1,
    "levelEducationCode": 1,
    "observation": "Teste de reajuste",
    "readjustmentPercent": 50,
    "priceTables": [
        {

"prospectCode": 138,

prospectName

companyCode":

"2"

1,
            "

prospectType

levelEducationCode":

"C"

1,
            "

candidateUserCode

id":

212

23,
            "

companyCode

internalId": "1|1|23",

"prospectPaymentPlans":

[

{

"active": true,

prospectionCode

statusFillDisciplines":

5

1,

"prospectCode":

138,

prospectPaymentPlanCode

terms":

115,

"companyCode": 1,

{
                    "

termCode

companyCode":

32

1,
                    "

termCodeDescription

priceTableCode":

"2023/1"

23,
                    "

paymentPlanCode

termId":

"2023/PS"

75,
                    "levelEducationCode": 1,
                    "

paymentPlanName

termCode": "

2023 Processo seletivo teste

2025/1",
                    "branchCode": 1

}

],

},

"prospectScholarShips": []

},

{

prospectionCode

companyCode":

5

1,

"prospectCode": 139,

        "priceTableCode": 23,

"prospectName":

"AAAA

sss",

prospectType

termId":

"P"

78,

"individualRegistrationCode":

"45657746589",

       "levelEducationCode": 1,

"prospectPaymentPlans":

[

{

"termCode": "202522",
                    "

prospectionCode

branchCode":

5,

2
                }

"prospectCode":

139,

"prospectPaymentPlanCode":

116

},
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "

termCode

id":

28

24,

termCodeDescription

internalId": "

2021

1|1|24",

paymentPlanCode

active":

"10112690"

true,

"levelEducationCode

"statusFillDisciplines":

2

1,

paymentPlanName

priceTableInUse":

"Plano

false,

1

-

Padrão

11

parcelas",

branchCode

terms":

1

}

],

        "companyCode": 1,

"prospectScholarShips":

[

{

"priceTableCode": 24,
                    "

prospectionCode

termId":

5

75,
                    "

prospectCode

levelEducationCode":

139

1,
                    "

prospectSchoolshipCode

termCode":

87

"2025/1",
                    "

companyCode": 1,

branchCode": 1

"scholarShipCode":

"13",

   }
            ]

"scholarShipName":

"DIRETORIA",

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

{
    "

levelEducationCode

internalId":

2

"1|1|76",
    "companyCode": 1,
    "levelEducationCode": 1,
    "readjustmentId": 76,

serviceCode

priceTables":

"27",

[
        {
            "

serviceName

companyCode":

"Mensalidade"

1,

termCode

levelEducationCode":

32

1,
            "id": 23,
            "

termCodeDescription

code": "

2021

ENG SOF 2009",

discountType

name": "

P

ENGENHARIA DE SOFTWARE",
            "statusFillDisciplines": 0,

"discountValue":

11.0000,

    "terms": [

"validityType": "P",

 {
                    "

startInstallment

companyCode": 1,
                    "

endInstallment

priceTableCode":

1

23,
                    "

branchCode

termId":

1

75,

}

] }

"levelEducationCode": 1,

{

prospectionCode

branchCode":

5,

"prospectCode":

140,

},

"prospectName":

"Antonio

Lucas

Peixoto",

"prospectType": "A",

               "companyCode": 1,

"studentCode":

"EB-00238",

       "priceTableCode": 23,

"prospectPaymentPlans":

[

{

"termId": 78,
                    "

prospectionCode

levelEducationCode":

5

1,
                    "

prospectCode

branchCode":

140,

2
                }
            ]

"prospectPaymentPlanCode":

117

},
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "

termCode

id":

23

24,
            "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}Exemplo 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/v1/prospection/prospections/3

Informações

icon	false
title	Exemplo de Entrada

/api/framework/v1/jobscheduler

Informações

icon	false
title	Exemplo de entrada 3 camadas

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

Propriedades obrigatórias:

processID, firstExecution, recurrent, executionParameter

executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "firstExecution": "2025-02-17T18:12:00-03:00",
    "recurrent": false,
    "executionParameter": {

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{ "prospects": [ { "prospectName": "Tomás Augusto", "prospectType": "A", "companyCode": 1, "studentCode": "ES-00219", "prospectPaymentPlans": [ { "companyCode": 1, "termCode": 32, "paymentPlanCode": "2.0", "levelEducationCode": 1, "branchCode": 1 }, { "companyCode": 1, "termCode": 32, "paymentPlanCode": "2023/PS", "levelEducationCode": 1, "branchCode": 1 } ],

prospectScholarShips

Context":

[

{
            "_params": {

companyCode

$CODCOLIGADA": 1,

scholarShipCode

$CODFILIAL":

"10"

1,

levelEducationCode

$CODTIPOCURSO": 1,

serviceCode

$CODUSUARIO": "

1

mestre",

termCode

$CODSISTEMA":

32,

"S"
            }

"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

 },
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "UserName": "mestre",
        "PrimaryKeyList": [

},

{

    "1|1|6"

"companyCode": 1,

]
        ],
        "

scholarShipCode

PrimaryKeyNames":

"12",

 [
            "internalId"

"levelEducationCode": 1,

  ],
        "HostName": "HOST",
        "

serviceCode

appliedMatrixCodeList":

"2",

[
            21,

"termCode":

10,

25,

"discountType":

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

 26
        ],
        "appliedMatrixCampusCodeList": [

}

"21|1",

]

    "25|1"

}

]

}
}

Informações

icon	false
title	Exemplo de entrada ambiente local

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

Propriedades obrigatórias:

processID, recurrent, executionParameter

executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames

icon

false

title

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "

prospectionCode

processID":

3

"EduVinculaTabelaPrecoMatrizAplicadaData",
    "

description

recurrent":

"Duplicação"

false,
    "

prospects

executionParameter":

[

{
        "Context": {
            "

prospectionCode

_params":

3,

"prospectCode":

141,

prospectName

$CODCOLIGADA":

"Tomás Augusto"

1,

"prospectType":

"A",

companyCode

$CODFILIAL": 1,

"studentCode":

"ES-00219",

"prospectPaymentPlans": [ {

"$CODTIPOCURSO": 1,
                "

prospectionCode

$CODUSUARIO":

3

"mestre",

prospectCode

$CODSISTEMA":

141,

"S"
            }

"prospectPaymentPlanCode": 118

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

companyCode

UserName":

1

"mestre",
        "PrimaryKeyList": [

"termCode": 32,

"paymentPlanCode": "2.0",

"1|1|6"
            ]

"levelEducationCode": 1

],
        "PrimaryKeyNames": [
            "

branchCode

internalId"

: 1

],

}

"HostName": "HOST",
        "appliedMatrixCodeList": [

{

 21,
            25,

"prospectionCode":

3,

   26
        ],

prospectCode

appliedMatrixCampusCodeList":

141,

[
            "21|1",

"prospectPaymentPlanCode":

119,

   "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

companyCode

jobScheduleId":

1

"105783",
    "status": "active",
    "lastModified": "2025-02-17T18:40:27-03:00",
    "processId": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "firstExecution": "

termCode": 32,

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

paymentPlanCode

user": "

2023/PS

mestre",
    "recurrent": false,
    "executionParameter": {

levelEducationCode

appliedMatrixCodeList":

1,

[
            21,

"branchCode":

1

25,

}

],

prospectScholarShips

appliedMatrixCampusCodeList": [

{

"21|1",
            "

prospectionCode": 3,

25|1"
        ],

prospectCode

CodColigada":

141

0,

"CodFilial": 0,

prospectSchoolshipCode

CodTipoCurso":

88

0,

"companyCode

"Initialized":

1

false,

        "PrimaryKeyList": [

"scholarShipCode":

"10",

    [
                "

levelEducationCode": 1,

1|1|6"
            ]

"serviceCode": "1"

],
        "PrimaryKeyNames": [
            "

termCode

internalId"

: 32,

],

discountType

PrimaryKeyTableName":

"P"

null,
        "OnlineMode": false,

discountValue

SyncExecution":

90.0000

false,

"HideProgressDialog": false,
        "

startDate

SaveParamsExecution":

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

false,

"CodUsuario": "mestre",

endDate

Context":

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

{
            "$id": "1",
            "

validityType

_params":

"T",

branchCode

$CODFILIAL": 1,

}

"$CODSISTEMA": "S",

{

"$CODCOLIGADA": 1,
                "

prospectionCode

$CODUSUARIO":

3

"mestre",
                "$CODTIPOCURSO": 1

"prospectCode":

141,

        },
            "

prospectSchoolshipCode

Environment":

89,

0
        },
        "UserName": "mestre",
        "

companyCode

ConnectionId":

1

null,
        "ConnectionString": null,

scholarShipCode

DriverType":

"12"

null,

"Ip": null,

levelEducationCode

HostName":

1

"",
        "JobServerHostName": "BHN050104619",

serviceCode

ActionName":

"2"

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,

branchCode": 1

Scheduler": 1,

}

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

]

}

"CanSendMail": false,

] }

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

CanWaitSchedule":

null

false,

"message":

"A

bolsa

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'.", "detailedMessage": null, "helpUrl": null

"SendMail": false,
        "FriendlyLogs": null,
        "SuccessMessage": "Processo executado com sucesso",
        "FailureMessage": "Falha na execução do processo",
        "

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

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": null,
    "message": "O código da prospecção não foi informado ou é inválido.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

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

Resultado Negativo

SaveLogInDatabase": true,
        "StatusMessage": null,
        "WaitSchedule": false,
        "IsolateProcess": false,
        "DisableIsolateProcess": false,
        "NetworkUser": "",
        "CustomData": null,
        "CanParallelize": false,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
    }
}

Informações

icon	false
title	Exemplo de

resultado negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "

code

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 4

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.1.2 - Order (Retorna os dados ordenados)

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.6 - GetOne (Recuperar prospecção pelo identificador)

1.2 - POST

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

1.2 - POST

1.2.1 - Post (Inserir uma Prospecção)

1.3 - PUT

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

1.4 - DELETE

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

2 - Matriz Aplicada

2.1 - GET

2.1.1 - Get All (Recuperar todas as matrizes aplicadas)

2.1.2 - Filter (Resultado filtrado)

2.1.3 - Paginação

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

2.1.5 - GetOne (Recuperar matriz aplicada pelo identificador)

2.2 - PUT

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

2.3 - DELETE

2.3.1 - Delete (Excluir uma matriz aplicada)

3 - Período Letivo de Ingresso

3.1 - GET

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

3.1.2 - Filter (Resultado filtrado)

3.1.3 - Paginação

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

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

3.2 - DELETE

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

4 - Reajuste de valores

4.1 - Obter filiais e períodos letivos

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

4.2 - Simular reajuste de valores

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

4.3 - Processar reajuste de valores

4.3.1 - POST (Processa reajuste de valores)

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