Versões comparadas

Chave

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

...

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name courseName

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetablepricetableappliedmatrixes?order=namecourseName

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

{
    "hasNext": false,
    "items": [
        {
            "companyCode": 1,
            "levelEducationCodebranchCode": 1,
            "idlevelEducationCode": 41,
            "internalIdappliedMatrixCode": "1|1|4"132,
            "codepriceTableCode": "00002"3,
            "namebranchName": "Tabela de Precos DoisFilial Belo Horizonte - Fantasia",
            "recCreatedOncourseCode": "2025-02-04T11:07:16.693-03:001-1",
            "activecourseName": false"Curso Tabela de Preços",
            "priceTableInUsecurriculumGridCode": false"1",
            "appliedMatrixescurriculumGridName": []"Matriz Tabela de Preços",
            "termsmajorCode": []"1",
            "termBranchesmajorName": []"Habilitação  Tabela de Preços",
        }    "classShiftCode": 11,
        {    "classShiftName": "INTEGRAL",
            "companyCodestatus": 10,
            "levelEducationCodedisciplines": 1[],
            "idactionState": 3,0
            "internalId": "1|1|3",},
        {
            "codecompanyCode": "00001"1,
            "namebranchCode": "Tabela de Precos Um"1,
            "recCreatedOnlevelEducationCode": "2025-02-04T11:01:30.617-03:00"1,
            "activeappliedMatrixCode": false132,
            "priceTableInUsepriceTableCode": false24,
            "appliedMatrixesbranchName": []"Filial Belo Horizonte - Fantasia",
            "termscourseCode": []"1-1",
            "termBranchescourseName": []
"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 (
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 courseName

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetablepricetableappliedmatrixes?order=-namecourseName

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/pricetablepricetableappliedmatrixes?{campo}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: codecourseCode

Valor: 000011-1

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetablepricetableappliedmatrixes?codecourseCode=000011-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,
			"levelEducationCodebranchCode": 1,
			"idlevelEducationCode": 31,
			"internalIdappliedMatrixCode": "1|1|3"132,
			"codepriceTableCode": "00001"3,
			"namebranchName": "TabelaFilial Belo deHorizonte Precos- UmFantasia",
			"recCreatedOncourseCode": "2025-02-04T11:01:30.617-03:001-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"activemajorName": false "Habilitação  Tabela de Preços",
			"priceTableInUseclassShiftCode": false11,
			"appliedMatrixesclassShiftName": []"INTEGRAL",
			"termsstatus": []0,
			"termBranchesdisciplines": [],
		}	"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.

...

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

Informações
iconfalse
titleExemplo de Resultado
{ "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": [] } ]

}

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
        }
    ]

Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

1.1.5 - Fields (Retorno de campos específicos no resultado)

...