Api clientes - Criar anotação

Regras de negócio

Cria uma nova anotação informando protocolo e no informando no body textro e se anotação é pública ou privada.

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/anotacao

POST

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

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

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

publica

OP

Boolean

true ou false

mensagem

OP

Obrigatório quando nenhum arquivo é enviado.

String

Texto da Anotação

idAtendente

OP

Int

Id do Atendente

chaveUnicaSolicitante

OP

String

Chave Única do Beneficiario

arquivos

OP

Array

Arquivos em base64 ou URL

Array arquivos

O array pode conter um objeto com dois parâmetros diferentes por linha.

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

url

OP

Obrigatório quando não possui o base64 no objeto.

String

URL do arquivo

A URL deve conter o mime type do arquivo no header de resposta.

base64

OP

String

Arquivo em formato base64.

O base64 deve incluir o prefixo iniciando com o mime type do arquivo. Ex:
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAU…

O limite do todo o objeto do corpo da requisição é de no máximo 1MB, considere esse limite ao enviar arquivos em base64. Para arquivos maiores, envie pelo parâmetro de url.

Request body

{ "publica": false, "mensagem" : "teste 123456789", "idAtendente": 14, "chaveUnicaSolicitante": "everson@mobilesaude.com.br", "arquivos": [ { "url": "https://site.mobilesaude.com.br/imagens/logo2.png" }, { "base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASoAAADFCAYAAADjX7.." } ] }


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

{ "status": true, "data": { "mensagem": "Anotação criada com sucesso!" }, "message": "Anotação criada com sucesso!", "critical": [], "statusCode": 200, "timestamp": 1720818881819 }

Mobile Saúde - Mosia Omnichannel