Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações
iconfalse
titleGetAll

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"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": []
		}
	]
}

...

Informações
iconfalse
titleGetOne

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

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

Informações
iconfalse
titleExemplo 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
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 3,
	"internalId": "1|1|3",
	"code": "00001",
	"name": "Tabela de Precos Um",
	"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	],
	"terms": [],
	"termBranches": [
		{
			"branchCode": 1
		}
	]
}

...

Informações
iconfalse
titlePost

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

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de Precos via Postman",
	"active": false,
	"appliedMatrixes": []
}
ou 
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de Precos via Postman",
	"active": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	]
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 12,
	"internalId": "1|1|12",
	"code": "00005",
	"name": "Tabela de Precos via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 12,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	]
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"code": null,
	"message": "Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

...

Informações
iconfalse
titlePatch

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

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

Informações
iconfalse
titleExemplo 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
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 14,
	"internalId": "1|1|14",
	"code": "00003",
	"name": "Tabela de Precos via Postman ALT",
	"active": false,
	"appliedMatrixes": [],
	"terms": []
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "companyCode": 1,
    "levelEducationCode": 1,
    "id": 14,
    "internalId": "1|1|14",
    "code": "00003",
    "name": "Tabela de Precos via Postman ALT",
    "active": false,
    "priceTableInUse": false,
    "appliedMatrixes": [],
    "terms": []
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"code": null,
	"message": "Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}


1.4 - DELETE

...

1.4.1 - Delete (Exclui uma

...

Tabela de preços)

...

Informações
iconfalse
titleDelete

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051prospectionCode: 5

internalId: 1|1|20

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

Informações
iconfalse
titleExemplo de Resultado Positivo Postman

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

Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "code": null,
    "message": "O códigoNão existe um cadastro da prospecçãotabela nãode foipreços informadoinformada oupara é inválidoexclusão.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

...