Versões comparadas

Version Versão antiga 2 Nova versão Atual
Alterações feitas por

Everson Delmaschio

Vinicius Fiorio Custodio

Gravado em

Chave

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

Regras de negócio

Detalhe da Ocorrência informando o protocolo.

Endpoint

Endpoint

Método

Header Content-Type

Descrição

https://api.mosiaomnichannel.com.br/clientes/ocorrencias/:protocolo

GET

application/json

Detalhe de uma ocorrência

Headers

Parâmetro

Obrigatório

Tipo

Descrição

Authorization

M

token do cliente

Token de autenticação do cliente

Parametros de Url

Parâmetro

Obrigatório

Tipo

Descrição

protocolo

M

Int

Protocolo da Ocorrência

Request body

Não é necessário enviar nenhuma informação no Body para o detalhe da ocorrência.

Bloco de código
languagejson
{}

Exemplo request

Bloco de código
languagebash
curl --request GET \
  --url https://api.mosiaomnichannel.com.br/clientes/ocorrencias/$informeNumeroDoProtocolo \
  --header 'Authorization: $informeChaveAuthorization'


Objetos e atributos de retorno

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método de detalhe de ocorrência.

Bloco de código
languagejson
{
    "status": true,
    "data": {
        "funcionalidade": {
            "id": null,
            "descricao": null
        },
        "ocorrencia": {
            "protocolo": "10101020221129000001",
            "dataRegistro": "2022-11-29T16:44:19.533Z",
            "dataAtualizacao": "2022-11-30T12:45:17.748Z",
            "dataVencimentoSla": "2022-11-30T16:44:19.533Z",
            "tipoOcorrencia": {
                "id": 128,
                "descricao": "Solicitação"
            },
            "assunto": {
                "id": 173,
                "descricao": "Atualização cadastral"
            },
            "solicitante": {
                "chaveUnica": "everson@mobilesaude.com.br",
                "numeroContrato": "00100200300400500609",
                "integracao": "implementação futura"
            },
            "beneficiario": {
                "chaveUnica": "everson@mobilesaude.com.br",
                "numeroContrato": "00100200300400500609",
                "integracao": "implementação futura"
            },
            "canal": {
                "id": "implementação futura",
                "descricao": "implementação futura"
            },
            "naturezaAtendimento": {
                "id": "implementação futura",
                "descricao": "implementação futura"
            },
            "solicitacao": {
                "template": {
                    "id": null,
                    "descricao": null
                },
                "formularios": [
                    {
                        "nome": null,
                        "idForm": "633c6daf04cf7c362778475f",
                        "itens": [
                            {
                                "nome": "Everson Delmaschio dos Santos",
                                "estado-civil": {
                                    "label": "Solteiro",
                                    "value": "1"
                                },
                                "certidao": [],
                                "estado": [
                                    {
                                        "label": [
                                            "Espírito Santo",
                                            "ES"
                                        ],
                                        "value": "ES"
                                    }
                                ],
                                "cidade": [
                                    {
                                        "label": [
                                            "Vila Velha"
                                        ],
                                        "value": "3205200"
                                    }
                                ],
                                "logradouro": "",
                                "complemento": "",
                                "comprovante-de-residencia": []
                            }
                        ]
                    }
                ]
            },
            "atendimento": {
                "atendente": {
                    "id": null,
                    "nome": null,
                    "email": null
                },
                "status": {
                    "id": 249,
                    "descricao": "Aprovado",
                    "dataAtribuicao": "implementação futura"
                },
                "anotacoes": [
                    {
                        "texto": "Teste",
                        "dataHora": "2022-11-29T16:44:19.768Z",
                        "ordem": "",
                        "atendente": {
                            "id": null,
                            "nome": null,
                            "email": null
                        },
                        "visibilidade": "externa"
                    },
                    {
                        "texto": "Status atribuido: Aprovado\nStatus anterior: Solicitado\nDesfecho: teste desfecho 2\nMotivo: Sem confirmação",
                        "dataHora": "2022-11-29T16:46:07.760Z",
                        "ordem": "",
                        "atendente": {
                            "id": null,
                            "nome": null,
                            "email": null
                        },
                        "visibilidade": "externa"
                    },
                    {
                        "texto": "teste 123456789",
                        "dataHora": "2022-11-29T16:47:11.818Z",
                        "ordem": "",
                        "atendente": {
                            "id": null,
                            "nome": null,
                            "email": null
                        },
                        "visibilidade": "interna"
                    },
                    {
                        "texto": "teste 123456789",
                        "dataHora": "2022-11-30T12:45:18.420Z",
                        "ordem": "",
                        "atendente": {
                            "id": null,
                            "nome": null,
                            "email": null
                        },
                        "visibilidade": "interna"
                    }
                ],
                "encerramento": {
                    "date": "2022-11-29T16:46:07.695Z",
                    "motivo": {
                        "id": 2261,
                        "descricao": "Sem confirmação"
                    },
                    "desfecho": "teste desfecho 2"
                },
                "abasComplementares": [
                    {
                        "idAba": 15,
                        "nomeAba": "aba simples",
                        "formularios": [
                            {
                                "nome": "Aba teste",
                                "idForm": "65673f964e75eb2bffaee5ef",
                                "itens": [
                                    {
                                        "identificacao": "teste",
                                        "arquivo": [],
                                        "botao-de-opcao": {
                                            "label": "Valor 1",
                                            "value": "1"
                                        },
                                        "caixa-de-checagem": [
                                            {
                                                "label": "Valor 1",
                                                "value": "1"
                                            }
                                        ],
                                        "data": "2023-11-29",
                                        "selecao": [
                                            {
                                                "label": [
                                                    "Valor 1"
                                                ],
                                                "value": "1"
                                            }
                                        ],
                                        "selecao-multi": [
                                            {
                                                "label": [
                                                    "Valor 1"
                                                ],
                                                "value": "1"
                                            }
                                        ],
                                        "senha": "",
                                        "area-de-texto": "teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste ",
                                        "texto": ""
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "idAba": 16,
                        "nomeAba": "Aba multi",
                        "formularios": [
                            {
                                "nome": "Aba teste",
                                "idForm": "65673f964e75eb2bffaee5ef",
                                "itens": [
                                    {
                                        "identificacao": "teste1",
                                        "arquivo": [],
                                        "botao-de-opcao": {
                                            "label": "Valor 1",
                                            "value": "1"
                                        },
                                        "caixa-de-checagem": [
                                            {
                                                "label": "Valor 1",
                                                "value": "1"
                                            }
                                        ],
                                        "data": "2023-11-29",
                                        "selecao": [
                                            {
                                                "label": [
                                                    "Valor 1"
                                                ],
                                                "value": "1"
                                            }
                                        ],
                                        "selecao-multi": [
                                            {
                                                "label": [
                                                    "Valor 1"
                                                ],
                                                "value": "1"
                                            }
                                        ],
                                        "senha": "mobi0406",
                                        "area-de-texto": "teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste ",
                                        "texto": ""
                                    },
                                    {
                                        "identificacao": "teste2",
                                        "arquivo": [],
                                        "botao-de-opcao": {
                                            "label": "Valor 1",
                                            "value": "1"
                                        },
                                        "caixa-de-checagem": [
                                            {
                                                "label": "Valor 1",
                                                "value": "1"
                                            }
                                        ],
                                        "data": "2023-11-29",
                                        "selecao": [
                                            {
                                                "label": [
                                                    "Valor 1"
                                                ],
                                                "value": "1"
                                            }
                                        ],
                                        "selecao-multi": [
                                            {
                                                "label": [
                                                    "Valor 1"
                                                ],
                                                "value": "1"
                                            }
                                        ],
                                        "senha": "mobi0406",
                                        "area-de-texto": "teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste teste ",
                                        "texto": ""
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    },
    "message": "Detalhes da ocorrência carregados com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1669816037887
}