Api clientes - Atualizar Status

Regras de negócio

Atualiza o status da ocorrência informado protocolo como parâmetro de url e no body os parâmetros obrigatórios. Também pode ser passado o desfecho da ocorrência quando status permitir finalização.

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
https://api.mosiaomnichannel.com.br/clientes/ocorrencias/:protocolo/status	PUT	application/json	Atualiza Status da Ocorrência

Headers

Parâmetro	Obrigatório	Tipo	Descrição

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

Parâmetro	Obrigatório	Tipo	Descrição
protocolo	M	Int	Protocolo da Ocorrência

Parametros de entrada

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idNovoStatus	M	Int	ID do Status
textoDesfecho	OP	String	Texto do Desfecho
idMotivoEncerramento	OP	Int	Id do Motivo de Encerramento
idAtendente	OP	Int	Id do Atendente
chaveUnicaSolicitante	M	Int	Chave única do Beneficiario

Request body

Serão enviados no BODY os seguintes parâmetros:

curl --request PUT \
  --url https://api.mosiaomnichannel.com.br/clientes/ocorrencias/10101020221130000006/status \
  --header 'Authorization: XPTO' \
  --header 'Content-Type: application/json' \
  --data '{
	"idNovoStatus" : 249,
    "textoDesfecho": "teste desfecho",
    "idMotivoEncerramento": 2261,
    "idAtendente": 44,
    "chaveUnicaSolicitante": "everson@mobilesaude.com.br"
}'

Em Nov 17, 2023 foi constatado um erro de digitação na documentação acima, o parâmetro idMotivoEncerramento estava incorretamente escrito como idMovitoEncerramento o que pode causar erros inesperados quando informado junto do texto de desfecho da ocorrência

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 Atualização de Status de ocorrência.

{
    "status": true,
    "data": {
        "protocolo": "10101020221130000006",
        "status": {
            "id": 249,
            "descricao": "Aprovado",
            "dataAtribuicao": "implementação futura"
        },
        "encerramento": {
            "date": "2022-11-30T13:47:48.581Z",
            "motivo": {
                "id": 2261,
                "descricao": "Sem confirmação"
            },
            "desfecho": "teste desfecho 2"
        }
    },
    "message": "Status da ocorrência atualizado com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1669816068653
}