Documento de Fachada
Produto: | Datasul |
Ocorrência: | Documentação de Fachada |
Dados do Documento | |
Nome | Fachada Horario |
Descrição |
|
Nome Físico | fchcrm/fchcrm1038.p |
Include com Parâmetros | fchcrm/fchcrm1038.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_horar |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1038.p |
Objetivo
Realizar a manutenção de horario.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
ttFilter | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
c_table | character |
| Tabela | Sim |
c_property | character |
| Propriedade | Sim |
c_value | character |
| Valor | Sim |
ttHorario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_horar_atendim | character |
| Nome horário atendimento | Sim |
log_suspenso | logical |
| Suspenso | Sim |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
REST_GET | ||
Requisito | N/A | |
Sintaxe | REST_GET (INPUT QP_start, INPUT QP_end, INPUT QP_properties, INPUT QP_values, INPUT QP_orderBy, INPUT QP_asc, INPUT QP_count, INPUT QP_type, OUTPUT REST_count, OUTPUT DATASET DSCRMHorario, OUTPUT TABLE RowErrors) | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
QP_start | Valor inicial da faixa de registros | |
QP_end | Valor final da faixa de registros | |
QP_properties | Propriedades | |
QP_values | Valores | |
QP_orderBy | Campo para ordenação | |
QP_asc | Ascendente ou Decrescente | |
QP_count | Contador | |
QP_type | Tipo | |
REST_count | Quantidade de registros selecionados | |
DATASET DSCRMHorario | Dataset com os registros selecionados | |
TABLE RowErros | Tabela de erros | |
Retorno | A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
Metodo Negócio
REST_GET_all |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_all (OUTPUT TABLE ttHorario, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os horários. |
| |
Parâmetros | Descrição |
| |
TABLE ttHorario | Tabela Horario |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os horários cadastrados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
REST_GET_detail |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_detail (INPUT PP_id, OUTPUT DATASET DSCRMHorario, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna o detalhe do horário solicitado. |
| |
Parâmetros | Descrição |
| |
PP_id | Codigo Identificador Sequencial |
| |
DATASET DSCRMHorario | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar o detalhe do horário solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|