Árvore de páginas

Versões comparadas

Chave

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

...

O ponto de entrada PMOBBE05 permite alterar todo o retorno do JSON da API auth:

Ponto de Entrada: PMOBBE05
Fonte: PMobBenef
Parâmetros
VariávelTipoObrigatórioDescrição
cMatricCaracterSimMatrícula do beneficiário
cCodPlaCaracterSimCódigo do plano
cVerPlaCaracterSimVersão do plano
dDatCarDataSimData do cálculo da carência
Retorno
VariávelTipoObrigatórioDescrição
aRetArraySim

Array contendo os grupos de carência no formato:

aRet[1,1] - Código do grupo (Caracter)

aRet[1,2] - Descrição do grupo (Caracter)

aRet[1,3] - Data da carência (Data)

Exemplo preenchimento:
aadd(aRet,{BAY->BAY_CODGRU,;
                  BAT->BAT_DESCRI,;
                  dDataCar+nMaior })



O ponto de entrada PMOBBE06 permite manipular o atributo de permissoes:

Ponto de Entrada: PMOBBE06
Fonte: PMobBenef
Parâmetros
VariávelTipoObrigatórioDescrição

cJsonPerm

CaracterSimJSON do atributo permissoes já processado
cContractCaracterNãoCódigo do contrato
cTipUsrCaracterNãoTipo do usuário
cNivelCobCaracterNãoNível de cobrança
cNomeEmpCaracterNãoNome da empresa
cGrauPaCaracterNãoGrau de parentesco
dDatBloCaracterNãoData de bloqueio
cMotBloData NãoMotivo de bloqueio
Retorno
VariávelTipoObrigatórioDescrição
aRetArraySim

Array contendo as funcionalidades no seguinte formato:

aRet[1,1] - Funcionalidade (Caracter)

aRet[1,2] - Acesso (Boolean)

aRet[1,3] - Mensagem bloqueio (Data)

aRet[1,4] - Ocultar (Boolean)


Exemplo de preenchimento:

aadd(aRet,{'Funcionalidade A',.T.,'',.F.})

aadd(aRet,{'Funcionalidade B',.F.,'MSG Bloqueio',.F.})



O ponto de entrada PMOBBE07 permite alterar o conteúdo do atributo redeAtendimento:

Ponto de Entrada: PMOBBE07
Fonte: PMobBenef
Parâmetros
VariávelTipoObrigatórioDescrição
oBeneficiaryJSON ObjectSimObjeto JSON montado pelo sistema
Retorno
VariávelTipoObrigatórioDescrição
cRedeAtendCaracterNãoMensagem que será apresentada no atributo redeAtendimento.



06. API LEMBRAR SENHA - rememberPass

...

Importante:  o campos Exib Tit Pag (BA0_MSTPAG) afeta diretamente o comportamento desta API, a descrição detalhada destes campos está descrita na sessão 3.c deste documento.



PONTOS DE ENTRADA


O ponto de entrada PMOBFI01 permite alterar o conteúdo do atributo tipoCobranca:

Ponto de Entrada: PMOBFI01
Fonte: PMobFinMod
Parâmetros
VariávelTipoObrigatórioDescrição
cFormRecCaracterSimForma de Recebimento definido no campo E1_FORMREC
nTituloIdNuméricoNãoRecno do registro SE1
Retorno
VariávelTipoObrigatórioDescrição
cTipoCobrancaCaracterSim

Tipo de cobrança do título sendo:

C = Consignação / desconto em folha
B = Boleto
D = Débito em conta



O ponto de entrada PMOBFI02 permite alterar o conteúdo do atributo situacao:

Ponto de Entrada: PMOBFI02
Fonte: PMobFinMod
Parâmetros
VariávelTipoObrigatórioDescrição
nValorBaseNuméricoNãoValor do título
dVenctoDataNãoData de vencimento
nTituloIdNuméricoNãoRecno do registro SE1
Retorno
VariávelTipoObrigatórioDescrição
cSituacaoCaracterSim

Situação do título sendo:

P = A Vencer (em aberto porém ainda não está vencido)
A = Atrasado (em aberto, porém já vencido)
B = Baixado (já foi pago)



O ponto de entrada PMOBFI04 permite alterar a query que será processsada ao realizar a busca dos títulos SE1:

Ponto de Entrada: PMOBFI04
Fonte: PMobFinMod
Parâmetros
VariávelTipoObrigatórioDescrição
cSqlCaracterSimQuery padrão do sistema
lMultiContractBooleanSimIndica o MultiContrato está habilitado
lLoginByCPFBooleanSimIndica se é login por CPF
cChaveBeneficiarioCaracterSimChave do beneficiário enviado no JSON de solicitação.
Retorno
VariávelTipoObrigatórioDescrição
cSqlCaracterSim

Query que será processada



O ponto de entrada PMOBFI05 permite alterar o atributo descricao dos títulos processados:

Ponto de Entrada: PMOBFI05
Fonte: PMobFinMod
Parâmetros
VariávelTipoObrigatórioDescrição
cPrefixoCaracterSimPrefixo do título
cNumCaracterSimNúmero do título
cParcelaCaracterSimParcela do título
cTipoCaracterSimTipo do título
Retorno
VariávelTipoObrigatórioDescrição
cDescricaoCaracterNão

Valor que será apresentado no atributo descricao



11. API DETALHE DÉBITO - detalheDebito

...