Sumário

Índice

exclude	Sumário

Objetivo

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

1 - Tabela de Preços

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 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 e das filiais dos períodos letivos por questão de performance. Essas informações serão retornadas com a utilização do GetOne para tabela de preço informada.

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNext": false,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de Precos",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

1.1.2 - Order (Retorna os dados ordenados)

Expandir

Informações

title	Parâmetros

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

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

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

Informações

icon	false
title	Order (Asc)

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

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

icon	false
title	Order (Desc)

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name

Tipo de Ordenação: Descendente

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

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNext": false,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de Precos Um",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		},
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 4,
			"internalId": "1|1|4",
			"code": "00002",
			"name": "Tabela de Precos Dois",
			"recCreatedOn": "2025-02-04T11:07:16.693-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

1.1.3 - Filter (Resultado filtrado)

Expandir

Informações

icon	false
title	Filter

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: code

Valor: 00001

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNext": false,
	"items": [
		{
			"companyCode": 1,
			"levelEducationCode": 1,
			"id": 3,
			"internalId": "1|1|3",
			"code": "00001",
			"name": "Tabela de Precos Um",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API da Tabela de Preços é possível adotar o padrão OData. Para entender melhor sobre a utilização desse padrão, acesse o link da documentação Utilizando filtros complexos - Exemplos do guia de API - ODATA.

1.1.4 - Paginação

Expandir

Informações

title	Parâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações

icon	false
title	Paginação

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 5

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable?page=1&pageSize=5

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Expandir

Informações

title	Parâmetros

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

Exemplo: ?fields=campo1

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

Informações

icon	false
title	Fields

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: code

Campo 2: name

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"hasNext": false,
	"items": [
		{
			"code": "00001",
			"name": "Tabela de Precos Um"
		},
		{
			"code": "00002",
			"name": "Tabela de Precos Dois"
		}
	]
}

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

Expandir

Informações

icon	false
title	GetOne

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

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 3,
	"internalId": "1|1|3",
	"code": "00001",
	"name": "Tabela de Precos 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
		}
	]
}

1.2 - POST

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

Informações

icon	false
title	Post

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

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de 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

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

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"code": null,
	"message": "Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

1.3 - PUT

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

Informações

icon	false
title	Patch

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

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|14

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"code": null,
	"message": "Não foi possível incluir/editar a tabela de preços. Código do nível de ensino está inválido.",
	"detailedMessage": null,
	"helpUrl": null,
	"details": null
}

1.4 - DELETE

1.4.1 - Delete (Exclui uma Tabela de preços)

Informações

icon	false
title	Delete

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|20

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

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

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

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": null,
    "message": "Não existe um cadastro da tabela de preços informada para exclusão.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

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

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.

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 prospect não foi informado ou é inválido",
    "detailedMessage": null,
    "helpUrl": null,
    "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

prospectionCode: Código da prospecção
prospectCode: Código do prospect
prospectSchoolshipCode: Código da bolsa do prospect
companyCode: Código da coligada
scholarShipCode: Código da bolsa
levelEducationCode: Código do nível de ensino
serviceCode: Código do serviço
termCode: Código do período letivo
discountType: Tipo de desconto (P = Percentual, V = Valor)
discountValue: Valor do desconto
startDate: Data inicial da vigência
endDate: Data final da vigência
validityType: Tipo de validade (T = Todo o período, P = Somente o período letivo)
branchCode: Código da filial

1.1.7 - Get All (Recuperar todas as matrizes aplicadas)

1.1.8 - GetOne (Recuperar matriz aplicada pelo identificador)

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

Informações

icon	false
title	GetOne

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

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3|132

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "companyCode": 1,
    "branchCode": 1,
    "levelEducationCode": 1,
    "appliedMatrixCode": 132,
    "priceTableCode": 3,
    "branchName": "Filial Belo Horizonte - Fantasia",
    "courseCode": "1-1",
    "courseName": "Curso Tabela de Preços",
    "curriculumGridCode": "1",
    "curriculumGridName": "Matriz Tabela de Preços",
    "majorCode": "1",
    "majorName": "Habilitação  Tabela de Preços",
    "classShiftCode": 11,
    "classShiftName": "INTEGRAL",
    "status": 0,
    "disciplines": [
        {
            "internalId": "1|3|132|1|0001_ES",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "0001_ES",
            "periodCode": 0,
            "periodDescription": "Período fixo",
            "disciplineName": "Estágio Supervisionado",
            "workload": 8.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|001Wal",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "001Wal",
            "periodCode": 0,
            "periodDescription": "Período fixo",
            "disciplineName": "6.Wal ",
            "workload": 5.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|146-1",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "146-1",
            "periodCode": 1,
            "periodDescription": "Período 1",
            "disciplineName": "7.DIREITO COMERCIAL I",
            "workload": 50.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|147-1",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "147-1",
            "periodCode": 1,
            "periodDescription": "Período 1",
            "disciplineName": "DIREITO COMERIAL II",
            "workload": 50.0000,
            "actionState": 1
        },
        {
            "internalId": "1|3|132|1|148-1",
            "companyCode": 1,
            "priceTableCode": 3,
            "appliedMatrixCode": 132,
            "levelEducationCode": 1,
            "disciplineCode": "148-1",
            "periodCode": 1,
            "periodDescription": "Período 1",
            "disciplineName": "DIREITO PENAL II",
            "actionState": 1
        }
    ],
    "actionState": 0
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 41

Nova versão 42

Chave

Sumário

Objetivo

1 - Tabela de Preços

1.1 - GET

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

1.1.2 - Order (Retorna os dados ordenados)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

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

1.2 - POST

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

1.3 - PUT

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

1.4 - DELETE

1.4.1 - Delete (Exclui uma Tabela de preços)

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

1.1.7 - Get All (Recuperar todas as matrizes aplicadas)

1.1.8 - GetOne (Recuperar matriz aplicada pelo identificador)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 41

Nova versão 42

Chave

Sumário

Objetivo

1 - Tabela de Preços

1.1 - GET

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

1.1.2 - Order (Retorna os dados ordenados)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

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

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

1.2 - POST

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

1.3 - PUT

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

1.4 - DELETE

1.4.1 - Delete (Exclui uma Tabela de preços)

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

1.1.7 - Get All (Recuperar todas as matrizes aplicadas)

1.1.8 - GetOne (Recuperar matriz aplicada pelo identificador)