Linha RM

Atalhos

Páginas filhas
  • Tabela de Preço - openAPI

Versões comparadas

Versão antiga 6

changes.mady.by.user Wesley Magno De Oliveira Costa

Gravado em

comparado com

Nova versão 7

changes.mady.by.user Wesley Magno De Oliveira Costa

Gravado em

Chave

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

...

Informações
iconfalse
titleGetAll

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

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
titleFilter

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: idcode

Valor: 300001

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

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 Um",
			"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
			"active": false,
			"priceTableInUse": false,
			"appliedMatrixes": [],
			"terms": [],
			"termBranches": []
		}
	]
}
Informações
titleFiltros 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.

...

Informações
iconfalse
titlePaginação

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

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

...

Informações
iconfalse
titleFields

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: prospectionCodecode

Campo 2: descriptionname

Url Utilizada: http://localhost:8051/api/educational/financial/v1/prospection/prospectionspricetable?fields=prospectionCodecode,descriptionname

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    	"hasNext": false,
    	"items": [
        {
            "prospectionCode": 1,
            "description		{
			"code": "00001",
			"name": "MatriculaTabela de ingressantesPrecos 2022Um"
        		},
        {
            "prospectionCode": 2,
            "description		{
			"code": "00002",
			"name": "ProspecçãoTabela 2024de -Precos Novo CursoDois"
        },
        {
            "prospectionCode": 3,
            "description": "Duplicação"
        }
    		}
	]
}

1.1.6 - GetOne (Recuperar

...

tabela de preços pelo identificador)

...


Informações
iconfalse
titleGetOne

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

Máscara de 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: 8051

prospectionCodeinternalId: 1|1|3

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "prospectionCode	"companyCode": 1,
    "description	"levelEducationCode": "Matricula de ingressantes 2022"1,
    "prospects	"id": [
        {
            "prospectionCode3,
	"internalId": "1|1|3",
            "prospectCode	"code": 91"00001",
	"name": "Tabela de          "prospectNamePrecos Um",
	"recCreatedOn": "12025-02-04T11:01:30.617-03:00",
            "prospectType	"active": false,
	"ApriceTableInUse": false,
            "candidateUserCode	"appliedMatrixes": 198,
            [
		{
			"companyCode": 1,
            "studentCode			"branchCode": "ES-00219",
            "prospectPaymentPlans": [
                {
                    "prospectionCode": 1,
                    "prospectCode": 91,
                    "prospectPaymentPlanCode": 77,
                    "companyCode": 1,
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "paymentPlanCode": "2.0",
                    "levelEducationCode": 1,
                    "paymentPlanName": "Plano 2",
                    "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,
			"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 Prospecção)

...