Linha RM

Atalhos

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

Versões comparadas

Versão antiga 51

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

Gravado em

comparado com

Nova versão 52

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

Gravado em

Chave

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

...

Expandir
Informações
iconfalse
titleDelete

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

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable/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": "Não existe um cadastro da tabela de preços informada para exclusão.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

2 - Matriz Aplicada

...

      Serão apresentados

...

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

  • GET

...

  • PUT
  • DELETE

2.1 - GET

...

2.2.1 - Get All (Recuperar todas as matrizes aplicadas)

Expandir
Informações
iconfalse
titleGetAll

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
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer 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
        }
    ]
}

...

2.2.2 - Order (Retorna os dados ordenados)

Expandir
Informações
titleParâ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
iconfalse
titleOrder (Asc)

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: courseName

Tipo de Ordenação: Ascendente

Url Utilizada:  http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?order=courseName

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer 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
        },
        {
            "companyCode": 1,
            "branchCode": 1,
            "levelEducationCode": 1,
            "appliedMatrixCode": 132,
            "priceTableCode": 24,
            "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
iconfalse
titleOrder (Desc)

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: courseName

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableappliedmatrixes?order=-courseName

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

...

2.2.3 - Filter (Resultado filtrado)

Expandir
Informações
iconfalse
titleFilter

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

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

...

2.2.4 - Paginação

Expandir
Informações
titleParâ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
iconfalse
titlePaginação

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetableappliedmatrixes?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/pricetableappliedmatrixes?page=1&pageSize=5

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer 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.2.5 - Fields (Retorno de campos específicos no resultado)

Expandir
Informações
titleParâ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
iconfalse
titleFields

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

Informações
iconfalse
titleExemplo 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
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"hasNext": false,
	"items": [
		{
			"code": "00001",
			"name": "Tabela de Precos Um"
		},
		{
			"code": "00002",
			"name": "Tabela de Precos Dois"
		}
	]
}

...