Api clientes - Criar Ocorrência

Regras de negócio

Cria uma nova ocorrência com os dados passados no body.

Endpoint

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

Endpoint	Método	Header Content-Type	Descrição
https://api.mosiaomnichannel.com.br/clientes/ocorrencias	POST	application/json	Cria uma 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 entrada

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

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idTipoOcorrencia	M	Int	ID do Tipo de Ocorrência
solicitante	M	Objeto	Objeto Solicitante
idFuncionalidade	OP	Int	ID da funcionalidade da nova ocorrência. Utilize um ID válido para seu ambiente. Se não informado, a ocorrência será exibida somente em “Meus protocolos”
numeroContrato	OP	String	Número do Contrato
idAssunto	OP	Int	Id do Assunto da Ocorrência
rascunho	OP	Boolean	Define se é Ocorrência é Rascunho
beneficiario	OP	Objeto	Objeto Beneficiario
formularios	OP	Array de Objeto de Formularios	Array com Objeto(s) de Formulário
anotacao	OP	String	Texto para Anotação

Objeto Solicitante [M]

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
nome	M	String	Nome Solicitante
chaveUnica	M	String	Chave Única
email	OP	String	Email
telefone	OP	String	Telefone

{
    "chaveUnica": "everson@mobilesaude.com.br",
    "nome": "Everson",
    "email": "everson@mobilesaude.com.br",
    "telefone": "27997981966"
}

Objeto Beneficiario [OP]

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
nome	M	String	Nome Solicitante
chaveUnica	M	String	Chave Única
email	OP	String	Email
telefone	OP	String	Telefone

{
    "chaveUnica": "everson@mobilesaude.com.br",
    "nome": "Everson",
    "email": "everson@mobilesaude.com.br",
    "telefone": "27997981966",
}

Objeto Formulario

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idForm	M	Int	Id do Formulário
formData	M	Array de Objeto	Objeto do FormData Preenchido

{
    "idForm": "633c6daf04cf7c362778475f",
    "formData": [
        {
            "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": []
        }
    ]
}

Request body

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 ocorrência.