Versões comparadas

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/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 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 de Período Letivo de Ingresso vinculado à Tabela de Preço com o ID informado para exclusão.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

4 - Reajuste de valores

...

      Nesta sessão serão apresentadas as três APIs principais usadas no reajuste de valores.

  • GET - http://{domínio}:{porta}/api/educational/v1/financial/pricetablebranchesandterms (Responsável por retornar lista de filiais e os períodos letivos disponíveis para seleção por filial)
  • POST - http://{domínio}:{porta}/api/educational/v1/financial/simulation/pricetablereadjustment (Responsável pela simulação do reajuste de valores)
  • POST - http://{domínio}:{porta}/api/educational/v1/financial/pricetableadjustment (Processa o reajuste de valores)

4.1 - Obter filiais e períodos letivos

...

4.1.1 - Get All (Recuperar todas filiais e todos períodos disponíveis para uso no reajuste)

Expandir
Informações
iconfalse
titleGetAll

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

Obs: Para execução é obrigatório informar pelos menos 1 internalId de tabela de preço e no máximo 20 internalId de tabela de preço. Cada internalId deve ser separado por ';'.

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|23

internalId: 1|1|24

Url Utilizada: http://localhost:8051/api/educational/v1/financial/pricetablebranchesandterms?1|1|23;1|1|24

Informações
iconfalse
titleExemplo de Resultado

{
    "hasNext": false,
    "items": [
        {
            "companyCode": 1,
            "branchCode": 1,
            "branchName": "Filial Belo Horizonte - Fantasia",
            "priceTableInternalIds": [
                "1|1|23",
                "1|1|24"
            ],
            "terms": [               
                {
                    "internalId": "1|1|74",
                    "companyCode": 1,
                    "priceTableCode": 0,
                    "termId": 74,
                    "levelEducationCode": 0,
                    "termCode": "2024/2",
                    "branchCode": 1
                },
                {
                    "internalId": "1|1|75",
                    "companyCode": 1,
                    "priceTableCode": 0,
                    "termId": 75,
                    "levelEducationCode": 0,
                    "termCode": "2025/1",
                    "branchCode": 1
                }
            ]
        },
        {
            "companyCode": 1,
            "branchCode": 2,
            "branchName": "Filial Rio de Janeiro",
            "priceTableInternalIds": [
                "1|1|23"
            ],
            "terms": [
                {
                    "internalId": "1|2|78",
                    "companyCode": 1,
                    "priceTableCode": 0,
                    "termId": 78,
                    "levelEducationCode": 0,
                    "termCode": "202522",
                    "branchCode": 2
                }
            ]
        }
    ]
}

4.2 - Simular reajuste de valores

...

4.2.1 - POST (Executa simulação do reajuste por matriz aplicada)

Expandir
Informações
iconfalse
titlePOST

A simulação é realizada por matriz aplicada da tabela de preço, seu retorno é como os valores devem ficar após o reajuste.

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/educational/v1/financial/simulation/pricetablereadjustment/

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "companyCode": 1,
    "branchCode": 1,
    "levelEducationCode": 1,
    "appliedMatrixCode": 140,
    "priceTableCode": 24,
    "readjustmentPercent": 2
}
Informações
iconfalse
titleExemplo de Resultado com sucesso (201 - Created)
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "companyCode": 1,
    "priceTableCode": 24,
    "appliedMatrixCode": 140,
    "levelEducationCode": 1,
    "readjustmentPercent": 2.0,
    "disciplines": [
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|A035-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "A035-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "ECONOMIA BRASILEIRA E INTERNACIONAL",
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|A038-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "A038-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "ADMINISTRAÇÃO FINANCEIRA",
            "workload": 68.0000,
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|A144-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "A144-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "INFORMÁTICA",
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|S049-1",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "S049-1",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "ÁLGEBRA LINEAR E GEOMETRIA ANALÍTICA",
            "actionState": 0
        },
        {
            "readjustmentPercent": 2.0,
            "internalId": "1|24|140|1|TPD2",
            "companyCode": 1,
            "priceTableCode": 24,
            "appliedMatrixCode": 140,
            "levelEducationCode": 1,
            "disciplineCode": "TPD2",
            "creditsValue": 50.00000,
            "creditsValueReadjustment": 51.0000000,
            "periodCode": 1,
            "periodDescription": "1° Periodo",
            "disciplineName": "MATEMÁTICA 1",
            "actionState": 0
        }
    ]
}
Informações
iconfalse
titleExemplo de Resultado com falha - (500 Internal server error)
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "code": null,
    "message": "Referência de objeto não definida para uma instância de um objeto.",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

4.3 - Processar reajuste de valores

...

4.3.1 - POST (Processa reajuste de valores)

Expandir
Informações
iconfalse
titlePOST

Efetua o reajuste dos valores da tabela de preço.

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "companyCode": 1,
    "levelEducationCode": 1,
    "observation": "Teste de reajuste",
    "readjustmentPercent": 50,
    "priceTables": [
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 23,
            "internalId": "1|1|23",            
            "active": true,
            "statusFillDisciplines": 1,                        
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "termCode": "2025/1",
                    "branchCode": 1                    
                },
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 78,
                    "levelEducationCode": 1,
                    "termCode": "202522",
                    "branchCode": 2
                }
            ]       
        },
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 24,
            "internalId": "1|1|24",            
            "active": true,
            "statusFillDisciplines": 1,
            "priceTableInUse": false,            
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 24,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "termCode": "2025/1",
                    "branchCode": 1                    
                }
            ]           
        }
    ]
}
Informações
iconfalse
titleExemplo de Resultado com sucesso (201 - Created)
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "internalId": "1|1|76",
    "companyCode": 1,
    "levelEducationCode": 1,
    "readjustmentId": 76,
    "priceTables": [
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 23,
            "code": "ENG SOF 2009",
            "name": "ENGENHARIA DE SOFTWARE",
            "statusFillDisciplines": 0,
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "branchCode": 1
                },
                {
                    "companyCode": 1,
                    "priceTableCode": 23,
                    "termId": 78,
                    "levelEducationCode": 1,
                    "branchCode": 2
                }
            ]
        },
        {
            "companyCode": 1,
            "levelEducationCode": 1,
            "id": 24,
            "code": "TSTRjs",
            "name": "Teste reajuste",
            "statusFillDisciplines": 0,
            "terms": [
                {
                    "companyCode": 1,
                    "priceTableCode": 24,
                    "termId": 75,
                    "levelEducationCode": 1,
                    "branchCode": 1
                }
            ]
        }
    ],
    "readjustmentPercent": 50.0,
    "observation": "Teste de reajuste"
}

5 - Processo vínculo Matriz Aplicada e Campus/Polo da Matriz Aplicada

...

O vínculo da tabela de preço como default para a matriz aplicada e/ou campus/polo da matriz aplicada, pode ser realizada pelo método POST da API de JobScheduler.

Expandir
Informações
iconfalse
titlePost

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/jobscheduler

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/jobscheduler

Informações
iconfalse
titleExemplo de entrada 3 camadas

Caso a propriedade recurrent seja igual a true, obrigatoriamente deve-se informar o Tipo de Recorrência.

Propriedades obrigatórias:

processID, firstExecution, recurrent, executionParameter

executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames


Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "firstExecution": "2025-02-17T18:12:00-03:00",
    "recurrent": false,
    "executionParameter": {
        "Context": {
            "_params": {
                "$CODCOLIGADA": 1,
                "$CODFILIAL": 1,
                "$CODTIPOCURSO": 1,
                "$CODUSUARIO": "mestre",
                "$CODSISTEMA": "S"
            }
        },
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "UserName": "mestre",
        "PrimaryKeyList": [
            [
                "1|1|6"
            ]
        ],
        "PrimaryKeyNames": [
            "internalId"
        ],
        "HostName": "HOST",
        "appliedMatrixCodeList": [
            21,
            25,
            26
        ],
        "appliedMatrixCampusCodeList": [
            "21|1",
            "25|1"
        ]
    }
}
Informações
iconfalse
titleExemplo de entrada ambiente local

Se o Host estiver executando local (3camadas = false) não é possível criar um agendamento de job. Neste cenário, para executar o job imediatamente, é preciso que no Body da requisição a recorrência esteja como 'false' e não sejam enviadas as propriedades "ScheduleDateTime" e Tipo de Recorrência.

Propriedades obrigatórias:

processID, recurrent, executionParameter

executionParameter: Context, ProcessName, UserName, PrimaryKeyList, PrimaryKeyNames


Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "processID": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "recurrent": false,
    "executionParameter": {
        "Context": {
            "_params": {
                "$CODCOLIGADA": 1,
                "$CODFILIAL": 1,
                "$CODTIPOCURSO": 1,
                "$CODUSUARIO": "mestre",
                "$CODSISTEMA": "S"
            }
        },
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "UserName": "mestre",
        "PrimaryKeyList": [
            [
                "1|1|6"
            ]
        ],
        "PrimaryKeyNames": [
            "internalId"
        ],
        "HostName": "HOST",
        "appliedMatrixCodeList": [
            21,
            25,
            26
        ],
        "appliedMatrixCampusCodeList": [
            "21|1",
            "25|1"
        ]
    }
}
Informações
iconfalse
titleExemplo de resultado positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "jobScheduleId": "105783",
    "status": "active",
    "lastModified": "2025-02-17T18:40:27-03:00",
    "processId": "EduVinculaTabelaPrecoMatrizAplicadaData",
    "firstExecution": "2025-02-17T18:40:00-03:00",
    "user": "mestre",
    "recurrent": false,
    "executionParameter": {
        "appliedMatrixCodeList": [
            21,
            25,
            26
        ],
        "appliedMatrixCampusCodeList": [
            "21|1",
            "25|1"
        ],
        "CodColigada": 0,
        "CodFilial": 0,
        "CodTipoCurso": 0,
        "Initialized": false,
        "PrimaryKeyList": [
            [
                "1|1|6"
            ]
        ],
        "PrimaryKeyNames": [
            "internalId"
        ],
        "PrimaryKeyTableName": null,
        "OnlineMode": false,
        "SyncExecution": false,
        "HideProgressDialog": false,
        "SaveParamsExecution": false,
        "CodUsuario": "mestre",
        "Context": {
            "$id": "1",
            "_params": {
                "$CODFILIAL": 1,
                "$CODSISTEMA": "S",
                "$CODCOLIGADA": 1,
                "$CODUSUARIO": "mestre",
                "$CODTIPOCURSO": 1
            },
            "Environment": 0
        },
        "UserName": "mestre",
        "ConnectionId": null,
        "ConnectionString": null,
        "DriverType": null,
        "Ip": null,
        "HostName": "",
        "JobServerHostName": "BHN050104619",
        "ActionName": null,
        "MasterActionName": null,
        "ActionModule": null,
        "JobID": {
            "ID": 105783,
            "ExecID": 1,
            "IsPriorityJob": false,
            "Children": []
        },
        "ShowReExecuteButton": true,
        "ExecutionId": "f414352f-fe43-444c-a437-80cb6390388e",
        "ProcessName": "Vinculo Matriz Aplicada e Campus/Polo",
        "ServerName": null,
        "ServiceInterface": null,
        "Scheduler": 1,
        "UseJobMonitor": true,
        "ScheduleDateTime": "2025-02-17T18:40:26-03:00",
        "CanSendMail": false,
        "CanWaitSchedule": false,
        "SendMail": false,
        "FriendlyLogs": null,
        "SuccessMessage": "Processo executado com sucesso",
        "FailureMessage": "Falha na execução do processo",
        "SaveLogInDatabase": true,
        "StatusMessage": null,
        "WaitSchedule": false,
        "IsolateProcess": false,
        "DisableIsolateProcess": false,
        "NetworkUser": "",
        "CustomData": null,
        "CanParallelize": false,
        "ShouldParallelize": false,
        "QuantityOfSplits": 0,
        "MinimumQuantityOfPrimaryKeysPerProcess": 1,
        "MaximumQuantityOfPrimaryKeysPerProcess": 1000,
        "NotifyFluig": false,
        "NotifyEmail": false,
        "NotifyEmailList": null
    }
}
Informações
iconfalse
titleExemplo de resultado negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "FE016",
    "Message": "O corpo da mensagem contém valores inválidos.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

...

6 - Descrição dos campos JSON de entrada/retorno

...

Expandir
titleDescrição dos campos JSON de entrada/retorno

Tabela de Preço

  • companyCode: Código da coligada
  • levelEducationCode: Código do nível de ensino/tipo de curso
  • id: Identificador único da tabela de preço
  • internalId: Identificador da tabela de preço no formato:
    • "Código da Coligada | Código do Nível de Ensino | Identificador da Tabela de Preço"
  • code: Código da tabela de preço definido pelo usuário no sistema
  • name: Nome da tabela de preço
  • reccreatedon: Data de criação da tabela de preço
  • active: Informa se a tabela de preço está ativa
  • pricetableinuse: Informa se a tabela de preço está em uso
  • appliedMatrixes: Listagem das matrizes aplicadas vinculadas à tabela de preço
  • terms: Listagem dos período letivos de ingresso vinculados à tabela de preço

Matriz Aplicada vinculada à Tabela de Preço

  • companyCode: Código da coligada
  • branchCode: Código da filial
  • levelEducationCode: Código do nível de ensino/tipo de curso
  • appliedMatrixCode: Identificador da matriz aplicada
  • priceTableCode: Identificador da tabela de preço
  • branchName: Nome da filial
  • courseCode: Código do curso
  • courseName: Nome do curso
  • curriculumGridCode: Código da grade/matriz curricular
  • curriculumGridName: Nome da grade/matriz curricular
  • majorCode: Código da habilitação
  • majorName: Nome da habilitação
  • classShiftCode: Código do turno
  • classShiftName: Nome do turno
  • Status: Informar o status do preenchimento do valor de créditos da disciplinas, valores possíveis
    • 0: Informa que todas as disciplinas não tem o valor de créditos preenchido
    • 1: Informa que têm algumas disciplinas sem ter o valor de créditos preenchido
    • 2: Informa que todas as disciplinas já tem o valor de créditos preenchido
  • disciplines: Listagem das disciplinas vinculadas a matriz aplicada
  • actionState: Informar o controle de modificação
    • 1: Informa a inclusão da matriz aplicada na tabela de preço
    • 2: Informa a remoção da matriz aplicada na tabela de preço

Disciplina vinculada à Matriz Aplicada

  • companyCode: Código da coligada
  • priceTableCode: Identificador da tabela de preço
  • appliedMatrixCode: Identificador da matriz aplicada
  • levelEducationCode: Código do nível de ensino/tipo de curso
  • internalId: Identificador da disciplina no formato:
    • "Código da Coligada | Identificador da Tabela de Preço | Identificador da Matriz Aplicada | Código do Nível de Ensino | Código da Disciplina"
  • disciplineCode: Código da disciplina
  • creditsValue: Valor de créditos
  • periodCode: Código do período
  • periodDescription: Descrição do período
  • disciplineName: Nome da disciplina
  • workload: Número da carga horária da disciplina
  • actionState: Informar o controle de modificação
    • 1: Informa a inclusão da disciplina da matriz aplicada
    • 2: Informa a remoção da disciplina da matriz aplicada
    • 3: Informa a modificação da disciplina da matriz aplicada
  • recCreatedBy: Usuário de criação
  • recCreatedOn: Data de criação
  • recModifiedBy: Usuário de alteração
  • recModifiedOn: Data de alteração

Período Letivo de Ingresso vinculado à Matriz Aplicada

  • companyCode: Código da coligada
  • priceTableCode: Identificador da tabela de preço
  • levelEducationCode: Código do nível de ensino/tipo de curso
  • termId: identidicador do período letivo de ingresso
  • internalId: Identificador da disciplina no formato:
    • "Código da Coligada|Identificador da Tabela de Preço|Identificador do Período Letivo de Ingresso|Código do Nível de Ensino"
  • termCode: Código do período letivo de ingresso definido pelo usuário no sistema
  • branchName: Nome da filial
  • branchCode: Código da filial
  • actionState: Informar o controle de modificação
    • 1: Informa a inclusão do período letivo de ingresso na tabela de preço
    • 2: Informa a remoção do período letivo de ingresso na tabela de preço
  • recCreatedBy: Usuário de criação
  • recCreatedOn: Data de criação
  • recModifiedBy: Usuário de alteração
  • recModifiedOn: Data de alteração

Processo vínculo Matriz Aplicada e/ou Campus/Polo da Matriz Aplicada

  • processID: Indentificador do processo no RM
    • Informar "EduVinculaTabelaPrecoMatrizAplicadaData"
  • firstExecution: Data da primeira execução do processo agendado
  • recurrent: Indica se a execução do processo é recorrente
  • executionParameter: Parâmetros de execução
    • Context: Contexto
      • _params
        • $CODCOLIGADA: Código da coligada
        • $CODFILIAL: Código da filial
        • $CODTIPOCURSO: Código do nível de ensino
        • $CODUSUARIO: Código do usuário
        • $CODSISTEMA: Código do sistema
          • Informar "S"
    • ProcessName: Nome do processo
      • Informar "Vinculo Matriz Aplicada e Campus/Polo"
    • UserName: Nome do usuário
    • PrimaryKeyList: Chave primária da tabela de preço
      • "Código da Coligada | Código do Nível de Ensino | Identificador da Tabela de Preço"
    • PrimaryKeyNames: Nome da chave primária da tabela de preço
      • Informar "internalId"
    • HostName: Nome do host
    • appliedMatrixCodeList: Lista de códigos da matriz aplicada
    • appliedMatrixCampusCodeList: Lista de códigos do campus/polo da matriz aplicada
      • "Identificador da matriz aplicada | Código do campus/polo"
  • daily: Utilizar somente se recurrent = true e o tipo de recorrência for diária. Consultar Tipo de Recorrência.
    • year: Ano
    • month: Mês
    • day: Dia
    • hour: Hora
    • minute: minuto
  • weekly: Utilizar somente se recurrent = true e o tipo de recorrência for semanal. Consultar Tipo de Recorrência.
    • daysOfWeek: Lista de dias da semana
    • hour: Hora
    • minute: Minutos
  • monthly: Utilizar somente se recurrent = true e o tipo de recorrência for mensal. Consultar Tipo de Recorrência. 
    • day: Dia
    • hour: Hora
    • minute: minuto