Versões comparadas

Chave

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

Tópicos:

Índice

1-

URL

base API

Base

2- Exemplo endpoints


Endpoint

EndpointMétodoDescrição

/reembolso_online/v1/api/reembolso/atribuirUsuarioReembolso

POST

Descrição do método POST.


Parâmetros

ParâmetroObrigatórioTipoDescrição
id_reembolsotrue


Cor do plano de fundo
color#EDEEF1
Inteiro


Id do reembolso para a qual será atualizado.

id_ms_usuariotrue


Cor do plano de fundo
color#EDEEF1
Inteiro



mshash

false


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.


Retorno API (Sucesso)

Bloco de código
languagejs
themeMidnight
linenumberstrue
{
    "status": true,
    "data": [
        {
            "id_ms_usuario": 41413
        }
    ],
    "critical": null,
    "timestamp": "2019-04-22T13:57:31-03:00",
    "msg": "Sucesso"
}

Exemplo de retorno API (Erro)

Bloco de código
languagejs
themeMidnight
linenumberstrue
{
    "status": false,
    "data": [],
    "critical": [
        {
            "COD": 0,
            "DESC": "Ocorreu um erro ao pegar as informações do usuário",
            "origem": "/mssuite/plataforma_beneficiario/reembolso_online/v1/api/reembolso/atribuirUsuarioReembolso",
            "trace": "#0 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v1/application/controllers/api/Reembolso.php(167): UsuarioModel->carregar('4133'),#1 [internal function]: Reembolso->atribuirUsuarioReembolso(),#2 /var/www/html/mssuite/shared/library/ci/3.1.0/system/core/CodeIgniter.php(514): call_user_func_array(Array, Array),#3 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v1/index.php(294): require_once('/var/www/html/m...'),#4 {main}",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2019-04-22T13:58:43-03:00",
    "msg": "Ocorreu um erro ao pegar as informações do usuário"
}
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