Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- integracoes:web-services-inserir-registro-atendimento [08/11/2022 13:05] – vivianne.sousa
+++ integracoes:web-services-inserir-registro-atendimento [14/08/2025 13:52] (atual) – tiago.moreno
@@ Linha 1: / Linha 1: @@
-{{ajuda:logo-gsan3.png?90|}}
+{{:ajuda:logo-gsan3.png?90}}
-\\
-====== WebService Inserir Registro de Atendimento  ======
+<code>
+\\  ====== WebService Inserir Registro de Atendimento  ======
-<columns>
+</code>
-O WebService recebe apenas requisições do tipo **POST**.
+<columns> O WebService recebe apenas requisições do tipo **POST**.
 Ele espera os seguintes Parâmetros:
-  - key, //String// contendo a chave de autenticação da empresa.
-  - unidadeAtendimento, //Integer// id da unidade de atendimento do Registro de Atendimento a ser Criado.
+  - key, //String//  contendo a chave de autenticação da empresa.
+  - unidadeAtendimento, //Integer//  id da unidade de atendimento do Registro de Atendimento a ser Criado.
   - nomeSolicitante, //String//, contendo o nome do solicitante.
-  - emailSolicitante, //String// contendo o email do solicitante.
+  - emailSolicitante, //String//  contendo o email do solicitante.
   - cpfCnpj, //String//cpf ou cnpj do solicitante.
-  - telefoneSolicitante, //String// telefone do solicitante.
+  - telefoneSolicitante, //String//  telefone do solicitante.
-  - matriculaImovel, //Integer// matrícula do imóvel.
+  - matriculaImovel, //Integer//  matrícula do imóvel.
-  - municipio, //Integer// id do município do imóvel ou do lugar da ocorrência.
+  - municipio, //Integer//  id do município do imóvel ou do lugar da ocorrência.
-  - logradouro, //Integer// id do logradouro do registro de atendimento.
+  - logradouro, //Integer//  id do logradouro do registro de atendimento.
-  - bairro, //Integer// id do Bairro do registro de atendimento.
+  - bairro, //Integer//  id do Bairro do registro de atendimento.
-  - cep, //String// cep do logradouro do registro de atendimento.
+  - cep, //String//  cep do logradouro do registro de atendimento.
-  - numero, //String// número do imóvel.
+  - numero, //String//  número do imóvel.
-  - localidade, //String// id da localidade da ocorrência.
+  - localidade, //String//  id da localidade da ocorrência.
-  - latitude, //String// Latitude do imóvel.
+  - latitude, //String//  Latitude do imóvel.
-  - longitude, //String// longitude do imóvel.
+  - longitude, //String//  longitude do imóvel.
-  - pavimentoRua, //String// id do tipo de pavimento da rua do local da ocorrência.
+  - pavimentoRua, //String//  id do tipo de pavimento da rua do local da ocorrência.
-  - pavimentoCalcada, //String// do tipo de pavimento da calçada do local da ocorrência.
+  - pavimentoCalcada, //String//  do tipo de pavimento da calçada do local da ocorrência.
-  - tipoEspecificacao, //String// id do tipo da especificação do Registro de Atendimento a ser aberto.
+  - tipoEspecificacao, //String//  id do tipo da especificação do Registro de Atendimento a ser aberto.
-  - pontoReferencia, //String// descrição textual de um ponto de referência com no máximo 60 caracteres.
+  - pontoReferencia, //String//  descrição textual de um ponto de referência com no máximo 60 caracteres.
   - observacao, //String//  observação textual sobre o Registro de Atendimento a ser aberto com no máximo 380 caracteres.
-  - meioSolicitacao, //Integer// id do meio de Solicitação pelo qual o Registro de Atendimento foi aberto.
+  - meioSolicitacao, //Integer//  id do meio de Solicitação pelo qual o Registro de Atendimento foi aberto. APENAS NA VERSÃO ESTADUAL.
-  - fotografiasBase64, //Array// de arquivos no formato jpg, png ou pdf que serão anexados no Registro de Atendimento a ser aberto.
+  - fotografiasBase64, //Array//  de arquivos no formato jpg, png ou pdf que serão anexados no Registro de Atendimento a ser aberto.
-</columns>
+<code>
-\\
+\\    * **Observação**, a validação dos campos depende das informações que são recebidas, devido a possibildiade de se abrir um Registro de Atendimento sem imóvel ou os campos latitude/longitude que só são obrigatórios caso um deles seja informado, por exemplo. Mais detalhes podem ser obtidos em  **[[postgres:integracao:uc1840|[UC1840 - Inserir Registro de Atendimento via webservice]]]**. \\ \\ Somente os campos abaixo, é que são considerados obrigatórios e validados em casa requisição:
-  * **Observação**, a validação dos campos depende das informações que são recebidas, devido a possibildiade de se abrir um Registro de Atendimento sem imóvel ou os campos latitude/longitude que só são obrigatórios caso um deles seja informado, por exemplo. Mais detalhes podem ser obtidos em  **[[postgres:integracao:uc1840|[UC1840 - Inserir Registro de Atendimento via webservice]]]**. \\ \\ Somente os campos abaixo, é que são considerados obrigatórios e validados em casa requisição:
+  - Unidade de Atendimento
-    - Unidade de Atendimento
+  - Nome do Solicitante
-    - Nome do Solicitante
+  - CPF/CNPJ do Solicitante
-    - CPF/CNPJ do Solicitante
+  - Pavimento da Rua
-    - Pavimento da Rua
+  - Pavimento da Calçada
-    - Pavimento da Calçada
+  - Tipo da Especificação
-    - Tipo da Especificação
+\\  ===== Exemplo de Requisição para o Sistema =====
-\\
+</code>
-===== Exemplo de Requisição para o Sistema =====
 com os seguintes Dados:
-|**Campo** | **Valor** |
+|**Campo** |**Valor** |
-|key | Abc123 |
+|key|Abc123|
-|bairro | 9 |
+|bairro|9|
-|tipoEspecificacao|1143 |
+|tipoEspecificacao|1143|
-|logradouro | 1515|
+|logradouro|1515|
-|municipio |810|
+|municipio|810|
-|numero| 2-218|
+|numero|2-218|
-|observacao| observações|
+|observacao|observações|
-| nomeSolicitante| João Silva|
+|nomeSolicitante|João Silva|
-|emailSolicitante | teste@teste.com |
+|emailSolicitante|teste@teste.com|
-|cpfCnpj | 08712376589|
+|cpfCnpj|08712376589|
-|unidadeAtendimento| 1000135|
+|telefoneSolicitante|0819963229933|
-|pavimentoRua| 0|
+|unidadeAtendimento|1000135|
-|pavimentoCalcada| 0|
+|pavimentoRua|0|
-|matriculaImovel| 1366021|
+|pavimentoCalcada|0|
-|meioSolicitacao | 1|
+|matriculaImovel|1366021|
+|meioSolicitacao|1|
-\\
 ===== A URL de Requisição Seria =====
 //<URL_SERVIDOR_GSAN>/gsan/inserirRegistroAtendimento//
-\\
 ===== Exemplo de JSON Esperado =====
 <code javascript>
 {
    "key":"Abc123",
    "bairro":9,
@@ Linha 83: / Linha 84: @@
    "emailSolicitante": "teste@teste.com",
    "cpfCnpj": "08712376589",
+   "telefoneSolicitante": "081996339922"
    "unidadeAtendimento":1000135,
    "pavimentoRua":0,
@@ Linha 89: / Linha 91: @@
    "meioSolicitacao": 1
 }
 </code>
 ===== Retorno em Caso de Sucesso =====
 <code javascript>
 {
@@ Linha 100: / Linha 105: @@
    "numeroProtocolo": "20201006356531"
 }
 </code>
-\\
 ===== Retorno em Caso de Erro =====
 <code javascript>
 {
@@ Linha 109: / Linha 116: @@
     "msg": "CPF/CNPJ do solicitante não é válido"
 }
 </code>
-\\
+Clique **[[:treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.
-Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.