Api clientes - Criar Ocorrência

Adicione uma legenda: clique duas vezes para pré-visualizar
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 |
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 do tipo Rascunho False == Ocorrência será exibida no painel do atendente True == Ocorrência será do tipo rascunho não sendo visível ao atendente ( caso seja necessário em algum período a exibição da mesma no painel utilize a api de Ativar ocorrências ) |
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 |
tags | OP | Array de Objetos de tags | Array com Objeto(s) de tags |
Objeto Solicitante [M]
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
nome | M | String | Nome Solicitante |
chaveUnica | M | String | Chave Única |
OP | String | ||
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 |
|---|---|---|---|
nome | M | String | Nome Solicitante |
chaveUnica | M | String | Chave Única |
OP | String | ||
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 |
|---|---|---|---|
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
{
"idFuncionalidade": 31,
"idTipoOcorrencia": "128",
"idAssunto": 173,
"rascunho": false,
"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",
},
"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
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.
{
"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
} |
Objeto tag
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
chave | M | String | Nome da tag |
valor | OP | String | Valor da tag |
{
"chave": "Estado"
"valor": "ES",
},
Mobile Saúde - Mosia Omnichannel