API de Ocorrências

1 Orientações gerais
2 End-point
- 2.1 Parâmetros
- 2.2 Exemplo de Retorno de Sucesso
- 2.3 Exemplo de Retorno de Falha

Orientações gerais

Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

End-point

End-point utilizado para ativar uma ocorrência rascunho criada automaticamente no início do acesso à funcionalidade customizada.

Endpoint	Método	Header Content-Type

Endpoint	Método	Header Content-Type
`/ocorrencia/ativar`	PUT	application/json

Parâmetros

Parâmetro	Requerido	Tipo	Descrição

Parâmetro	Requerido	Tipo	Descrição
instanciaApp	Sim	String	Sandbox == 1 Produção == 2
chavePasse	Sim	String	Chave Passe recebida via QueryString no redirecionamento para a URL configurada.
chaveFuncionalidade	Sim	String	Campo chave gerada automaticamente no cadastro da funcionalidade customizada e disponível no Painel Mosia OmniChannel.
idOcorrencia	Sim	String	Id da Ocorrência retornado. Recuperado através da API de acesso a Dados.

Exemplo de Retorno de Sucesso

{
    "status": true,
    "data": [],
    "message": "Ocorrencia ativada com sucesso.'",
    "critical": [
        {}
    ],
    "statusCode": 403,
    "timestamp": 1635347170840
}

Exemplo de Retorno de Falha

{
    "status": false,
    "data": [],
    "message": "Ocorreu uma falha interna no servidor. Por favor tente novamente mais tarde.'",
    "critical": [
        {}
    ],
    "statusCode": 403,
    "timestamp": 1635347170840
}