Versões comparadas

Chave

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

Tópicos:

Índice

URL Base

2- Exemplo endpoints


Endpoint

EndpointMétodoDescrição

/plataforma_beneficiario/reembolso_online/v1/api/status/listar

GET

Lista os status de Reembolso solicitados.


Parâmetros

ParâmetroObrigatórioTipoDescrição
id_operadoratrue


Cor do plano de fundo
color#EDEEF1
Inteiro


Id da operadora para a qual serão buscados os grupos de menu

mshash

true


Cor do plano de fundo
color#EDEEF1
idtipo
String


HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

4- Exemplo de retorno


Retorno API (Sucesso)

Bloco de código
languagejs
themeMidnighttitleRetorno API sucesso
linenumberstruecollapsetrue
{
    "status": true,
    "data": [
        {
            "id_status_reembolso": 1,
            "nome": "Solicitado",
            "imagem": "reembolso_1",
            "cor": "#7ac0e7",
            "id_operadora": 0,
            "id_aplicacao": 4,
            "descricao": null,
            "texto_email_beneficiario": null,
            "texto_email_operadora": null,
            "texto_inapp": null,
            "texto_sms": null,
            "envia_email_operadora": 1,
            "envia_email_beneficiario": 1,
            "informa_data_manual": 0,
            "envia_notificacao_inapp": 0,
            "envia_notificacao_sms": 0,
            "exige_valor_reembolsado": 0,
            "exige_campo_observacao": 0,
            "informa_numero_lote": 0,
            "status_solicitado": 1,
            "se_aplica_em_despesa": 1
        },
        {
            "id_status_reembolso": 2,
            "nome": "Aprovado",
            "imagem": "reembolso_1",
            "cor": "#68b828",
            "id_operadora": 0,
            "id_aplicacao": 4,
            "descricao": null,
            "texto_email_beneficiario": null,
            "texto_email_operadora": null,
            "texto_inapp": null,
            "texto_sms": null,
            "envia_email_operadora": 0,
            "envia_email_beneficiario": 1,
            "informa_data_manual": 0,
            "envia_notificacao_inapp": 0,
            "envia_notificacao_sms": 0,
            "exige_valor_reembolsado": 1,
            "exige_campo_observacao": 0,
            "informa_numero_lote": 0,
            "status_solicitado": 0,
            "se_aplica_em_despesa": 1
        },
        {
            "id_status_reembolso": 3,
            "nome": "Recusado",
            "imagem": "reembolso_7",
            "cor": "#CC563B",
            "id_operadora": 0,
            "id_aplicacao": 4,
            "descricao": null,
            "texto_email_beneficiario": null,
            "texto_email_operadora": null,
            "texto_inapp": null,
            "texto_sms": null,
            "envia_email_operadora": 0,
            "envia_email_beneficiario": 1,
            "informa_data_manual": 0,
            "envia_notificacao_inapp": 0,
            "envia_notificacao_sms": 0,
            "exige_valor_reembolsado": 0,
            "exige_campo_observacao": 1,
            "informa_numero_lote": 0,
            "status_solicitado": 0,
            "se_aplica_em_despesa": 1
        }
    ],
    "critical": null,
    "timestamp": "2019-04-22T12:05:17-03:00",
    "msg": "Sucesso"
}


Nota
titleATENÇÃO

Esse endpoint não possui retorno de erro mesmo enviando dados inválidos ele retorna como se não tivesse registro. Padrões documentação API.