[App Municipal] Avisos

Organização: Município da Guarda
Tema: Serviços Públicos
Licença: Creative Commons Attribution 4.0 International
Status: Approved
Última atualização:
Descrição:

API para disponibilização estruturada de avisos operacionais relacionados com serviços municipais e infraestruturas, garantindo acesso rápido e normalizado a informações críticas para cidadãos e entidades.

A API fornece dados em formato JSON, permitindo que aplicações e sistemas consultem avisos atualizados sobre cortes, condicionamentos e desvios de trânsito, manutenção das condutas de fornecimento de água, e outras intervenções relevantes, com suporte para pesquisa por localização, tipo e período.

Funcionalidades principais:

  • Pesquisa por data.
  • Metadados completos: título, descrição, localização, período de vigência e estado.
  • Respostas otimizadas para integração com portais, aplicações móveis e painéis informativos.

Benefícios:

  • Informação centralizada e atualizada para maior transparência e planeamento.
  • Apoio à mobilidade urbana e à gestão eficiente dos serviços.
  • Integração simplificada com sistemas internos e externos.

Endpoints

NomeURLMétodo
Endpoint V1.0 https://od.mun-guarda.pt/api/appmunicipal/avisos GET

Schemas

Schema URL
https://od.mun-guarda.pt/files/schemas/2025/schema_20251220143644.json
Schema Media Type
application/schema+json
Schema JSON
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "uniqueItems": true,
          "minItems": 1,
          "items": {
            "required": [
              "id",
              "status",
              "featured",
              "title",
              "created_at",
              "updated_at"
            ],
            "properties": {
              "id": {
                "type": "number"
              },
              "status": {
                "type": "string",
                "minLength": 1
              },
              "featured": {
                "type": "boolean"
              },
              "title": {
                "type": "string",
                "minLength": 1
              },
              "category": {
                "type": "array",
                "uniqueItems": true,
                "minItems": 1,
                "items": {
                  "required": [
                    "id",
                    "title"
                  ],
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "title": {
                      "type": "string",
                      "minLength": 1
                    }
                  }
                }
              },
              "image": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "minLength": 1
                  },
                  "alt": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "required": [
                  "url",
                  "alt"
                ]
              },
              "content": {
                "type": "array",
                "uniqueItems": true,
                "minItems": 1,
                "items": {
                  "required": [
                    "type",
                    "title"
                  ],
                  "properties": {
                    "type": {
                      "type": "string",
                      "minLength": 1
                    },
                    "title": {
                      "type": "string",
                      "minLength": 1
                    },
                    "setup": {
                      "type": "object",
                      "properties": {
                        "items": {
                          "type": "array",
                          "uniqueItems": true,
                          "minItems": 1,
                          "items": {
                            "required": [
                              "url",
                              "label",
                              "target"
                            ],
                            "properties": {
                              "url": {
                                "type": "string",
                                "minLength": 1
                              },
                              "label": {
                                "type": "string",
                                "minLength": 1
                              },
                              "target": {
                                "type": "string",
                                "minLength": 1
                              }
                            }
                          }
                        }
                      },
                      "required": [
                        "items"
                      ]
                    }
                  }
                }
              },
              "images_gallery": {
                "type": "array",
                "items": {
                  "required": [],
                  "properties": {}
                }
              },
              "created_at": {
                "type": "string",
                "minLength": 1
              },
              "updated_at": {
                "type": "string",
                "minLength": 1
              }
            }
          }
        }
      },
      "required": [
        "items"
      ]
    }
  },
  "required": [
    "success",
    "data"
  ]
}

Ficheiros

NomeFormatoTamanho

Versão Atual

  • Status do Schema: Approved
  • Última Atualização:
  • Versão Atual: 1