next.kolumbus.no

På oppfordring har vi snekret sammen en liten tjeneste som kan benyttes for å programmatisk hente ut en liste over de publiserte REGTOPP datasettene våre. På sikt kan det tenkes at denne tjenesten også vil kunne inkludere datasett i GTFS format. Tilgang til våre rutedata krever at man registrerer seg og aksepterer våre betingelser for bruk.

Å benytte seg av tjenesten er så enkelt som å gjøre en HTTP GET forespørsel til følgende URL:

http://rkt.no/rutedata/service.svc/json/datasets/regtopp

Du vil da, hvis alt gå riktig for seg, få returnert en liste over tilgjengelige REGTOPP datasett i JSON format. Merk at dette er en såpass ny tjeneste at endringer kan forekomme. Følgende er et eksempel på data som tjenesten kan returnere:

 {  
   "requestStatus":"ok",  
   "datasets":[  
    {  
      "type":"regtopp",  
      "validFrom":"2011-10-31",  
      "validTo":"2011-12-16",  
      "lastUpdated":"2011-11-14T12:13:01+01:00",  
      "url":"http:\/\/rkt.no\/rutedata\/regtopp\/kolumbus_regtopp_20111031-20111216.zip"  
    },  
    {  
      "type":"regtopp",  
      "validFrom":"2011-12-17",  
      "validTo":"2012-01-01",  
      "lastUpdated":"2011-12-05T15:03:22+01:00",  
      "url":"http:\/\/rkt.no\/rutedata\/regtopp\/kolumbus_regtopp_20111217-20120101.zip"  
    }  
   ]  
 }  

Ved feil kan det returneres noe slik som dette:

 {  
   "requestStatus":"error",  
   "requestMessage":"Unsupported data set type specified."  
 }  

Innholdet i svaret som returneres er forhåpentligvis lett å forstå. Her er en kort forklaring på de forskjellige feltene:

• requestStatus – Status for forespørselen. “ok” hvis alt er greit. Hvis noe er galt returneres en verdi annet enn “ok”.
• requestMessage – Beskrivelse av tilstanden til forespørselen. Hvis noe er galt så kan det ligge en relevant melding her, ellers er feltet ikke inkludert.
• datasets –Liste med alle tilgjengelige datasett.
  • type– Beskriver typen datasett. Mulige verdier er:
    • regtopp – Rutedata i REGTOPP formatet.
  • validFrom – Datasettet er gyldig fra og med denne datoen.
  • validTo – Datasettet er gyldig til og med denne datoen.
  • lastUpdated – Dato og tidspunkt (med angivelse av tidssone) for når datasettet sist var oppdatert. Et datasett kan bli oppdatert både før og i løpet av gyldighetsperioden av forskjellige årsaker. Følg med på endringer i dette feltet og pass på å laste ned oppdaterte datasett når de gjøres tilgjengelig.
  • url – URL hvor datasettet kan hentes fra.

Formatet på dato og tidspunkt følger (forhåpentligvis) ISO 8601 standarden.

Husk at endringer kan forekomme i tjenesten så anse dette som en tidlig beta. Ja, kall det gjerne en pilot-test

Legg gjerne inn en kommentar hvis du oppdager at noe er feil, uklart eller om du ser andre muligheter for forbedringer. Burde vi f.eks. spesifisere versjonsnummer av REGTOPP dataene i “type” feltet? Burde vi oppgi et eget versjonsnummer på tjenesten i tilfelle det skjer endringer?

This entry was posted on 21-des-2011 at 17:03 and is filed under Uncategorized. Du kan følge svarene til dette innlegget gjennom via RSS 2.0 feed'en. Du kan legge igjen et svar, eller et tilbaketråkk fra din egen side.