Comparação de Páginas

Regras de negócio

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

Endpoint

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
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
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
nome	M	String	Nome Solicitante
chaveUnica	M	String	Chave Única
email	OP	String	Email
telefone	OP	String	Telefone

Bloco de código
{ "chaveUnica": "everson@mobilesaude.com.br", "nome": "Everson", "email": "everson@mobilesaude.com.br", "telefone": "27997981966" }

Objeto Beneficiario [OP]

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

numeroContrato

M

String

Número do Contrato

Bloco de código
{ "chaveUnica": "everson@mobilesaude.com.br", "nome": "Everson", "email": "everson@mobilesaude.com.br", "telefone": "27997981966", "numeroContrato": "00100200300400500609" }

Objeto Formulario

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

Bloco de código

{
    "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

Bloco de código

language	json

{
    "idFuncionalidade": 31,
    "idTipoOcorrencia": "128",
    "idAssunto": 173,
    "rascunho": 0,
    "solicitante": {
        "chaveUnica": "everson@mobilesaude.com.br",
        "nome": "Everson",
        "email": "everson@mobilesaude.com.br",
        "telefone": "27997981966"
    },
    "numeroContrato": "00100200300400500609"
    "beneficiario": {
        "chaveUnica": "everson@mobilesaude.com.br",
        "nome": "Everson",
        "email": "everson@mobilesaude.com.br",
        "telefone": "27997981966",

"numeroContrato": "00100200300400500609"


    },
    "anotacao": "Teste",
    "formularios": [
        {
            "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": []
                }
            ]
        }
    ]
}

Objetos e atributos de retorno

...

Está indicado abaixo a estrutura de retorno do método de criação de ocorrência.

Bloco de código

language	json

{
    "status": true,
    "data": {
        "protocolo": "10101020221130000006"
    },
    "message": "Ocorrência registrada com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1669816018898
}{
    "status": true,
    "data": {
        "protocolo": "10101020221101000001"
    },
    "message": "Ocorrência registrada com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1667317299833
}

Versões comparadas

Versão antiga 7

Nova versão Atual

Chave

Regras de negócio

Endpoint

Headers

Parametros de entrada

Objeto Solicitante [M]

Objeto Beneficiario [OP]

Objeto Formulario

Request body

Objetos e atributos de retorno