Versões comparadas

Chave

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

...

Expandir
Informações
iconfalse
titleGetAll

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...

{
    "hasNext": false,
    "items": [
        {
            "internalId": "1|3|73|1|2024/1",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 73,
            "levelEducationCode": 1,
            "termCode": "2024/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|3|74|1|2024/2",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 74,
            "levelEducationCode": 1,
            "termCode": "2024/2",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|3|75|1|2025/1",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 75,
            "levelEducationCode": 1,
            "termCode": "2025/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        }
    ]
}

...

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/pricetableterms?order={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: termCode

Tipo de Ordenação: Ascendente

Url Utilizada:  http://localhost:8051/api/educational/financial/v1/pricetableterms?order=termCode

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...

{
    "hasNext": false,
    "items": [
        {
            "internalId": "1|3|73|1|2024/1",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 73,
            "levelEducationCode": 1,
            "termCode": "2024/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|3|74|1|2024/2",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 74,
            "levelEducationCode": 1,
            "termCode": "2024/2",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|3|75|1|2025/1",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 75,
            "levelEducationCode": 1,
            "termCode": "2025/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        }
    ]
}

Informações
iconfalse
titleOrder (Desc)

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

...

Expandir
Informações
iconfalse
titleFilter

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: termId

Valor: 74

Url Utilizada:  http://localhost:8051/api/educational/financial/v1/pricetableterms?termId=74

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"hasNext": false,
	"items": [
		{
			"internalId": "1|3|74|1|2024/2",
			"companyCode": 1,
			"priceTableCode": 3,
			"termId": 74,
			"levelEducationCode": 1,
			"termCode": "2024/2",
			"branchCode": 1,
			"branchName": "Filial Belo Horizonte - Fantasia"
		}
	]
}
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.

...

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/pricetableterms?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/pricetableterms?page=1&pageSize=5

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...

{
    "hasNext": false,
    "items": [
        {
            "internalId": "1|3|73|1|2024/1",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 73,
            "levelEducationCode": 1,
            "termCode": "2024/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|3|74|1|2024/2",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 74,
            "levelEducationCode": 1,
            "termCode": "2024/2",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|3|75|1|2025/1",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 75,
            "levelEducationCode": 1,
            "termCode": "2025/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        }
    ]
}

...