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

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

3.1.

...

2 - Filter (Resultado filtrado)

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|1|3|74",
            "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.

3.1.

...

3 - 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/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|1|3|73",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 73,
            "levelEducationCode": 1,
            "termCode": "2024/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|1|3|74",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 74,
            "levelEducationCode": 1,
            "termCode": "2024/2",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "internalId": "1|1|3|75",
            "companyCode": 1,
            "priceTableCode": 3,
            "termId": 75,
            "levelEducationCode": 1,
            "termCode": "2025/1",
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia"
        }
    ]
}

3.1.

...

4 - 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/pricetableterms?fields={campos}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: termCode

Campo 2: branchName

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetableterms?fields=termCode,branchName

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

{
    "hasNext": false,
    "items": [
        {
            "termCode": "2024/1",
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "termCode": "2024/2",
            "branchName": "Filial Belo Horizonte - Fantasia"
        },
        {
            "termCode": "2025/1",
            "branchName": "Filial Belo Horizonte - Fantasia"
        }
    ]
}

3.1.

...

5 - GetOne (Recuperar período letivo de ingresso pelo identificador)

Expandir
Informações
iconfalse
titleGetOne

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3|73

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "internalId": "1|1|3|73",
    "companyCode": 1,
    "priceTableCode": 3,
    "termId": 73,
    "levelEducationCode": 1,
    "termCode": "2024/1",
    "branchCode": 1,
    "branchName": "Filial Belo Horizonte - Fantasia"
}

...