Linha RM

Atalhos

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

Versões comparadas

Versão antiga 36

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

Gravado em

comparado com

Nova versão 37

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

Gravado em

Chave

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

...

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

Expandir
titleGetAll
Informações
iconfalse
titleGetAll

Recupera todas as tabela de preços sem retornar a listagem 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": []
		}
	]
}

1.1.2 - Order (Retorna os dados ordenados)

Order
Expandir
title
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/pricetable?order={campo}

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

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable?order=-name

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

...