Há greve.getAPI()

hagreve.com providencia uma API simples para obter a lista das próximas greves.

Para a versão v1, apenas um método está disponível. Esse método devolve a lista das próximas greves, com greves activas e canceladas.

Por omissão, o método a usar para pedidos à API é o método GET do protocolo http. A autenticação, por enquanto, é inexistente. Deve ser utilizado um user-agent relevante à aplicação que invoca a API.

Objectos

Strike

O objecto strike tem os seguintes atributos:

• description:string - Uma descrição da greve ("This is a strike description.");
• start_date, end_date:string - Datas para o início e fim da greve ("2011-11-30 20:25:23");
• source_link:string - URL da fonte dos dados ("http://example.com");
• all_day:boolean - true se a greve for de dias inteiros (true)
  NOTA: as horas são irrelevantes e não devem ser mostradas se for uma greve de dia inteiro;
• canceled:boolean - true se a greve tiver sido cancelada (false);
• submitter:object - Descreve o autor do aviso. Tem os seguintes campos:
  • first_name:string - Primeiro nome do autor do aviso ("José");
  • last_name:string - Último nome do autor do aviso ("Silva");
• company:object - Descreve a empresa afectada pela greve. Tem os seguintes campos:
  • name:string - Nome da empresa ("Empresa A")

Métodos

Obter a lista das próximas greves

URL: /api/v1/strikes
Argumentos: nenhum
Resposta: A lista de objectos que descrevem as próximas greves.

Resposta exemplo:

json
[
    { "description": "Esta é uma descrição de uma greve.", 
      "end_date": "2011-11-30 20:25:23", 
      "source_link": "http://example.com", 
      "all_day": true, 
      "start_date": "2011-11-03 20:25:17", 
      "canceled": false, 
      "submitter": {
          "first_name": "José", 
          "last_name": "Silva"
      }, 
      "company": {
          "name": "Empresa B"
      }
    }, 
    {
      "description": "Descrição dois.", 
      "end_date": "2011-11-12 23:00:00", 
      "source_link": "http://example.com/greve2", 
      "all_day": true, 
      "start_date": "2011-11-12 20:00:00", 
      "canceled": true, 
      "submitter": {
          "first_name": "José", 
          "last_name": "Silva"
      }, 
      "company": {
          "name": "Empresa A"
      }
    }, 
    {
      "description": "Descrição um.", 
      "end_date": "2011-11-22 18:53:09", 
      "source_link": "http://example.com/greve", 
      "all_day": true, 
      "start_date": "2011-11-22 18:53:08", 
      "canceled": false, 
      "submitter": {
          "first_name": "João", 
          "last_name": "Cruz"
      }, 
      "company": {
          "name": "Empresa A"
      }
    }
]