札幌オープンデータAPI仕様
概要
札幌オープンデータAPIでは、HTTPを使ったRESTful APIを提供する。 今回提供するエンドポイントは、次の通りである。
https://api-sapporo.odcity.org/api/v1/
札幌情報オープンデータAPIは、地理情報による検索が可能かどうかによってAPIが異なる。
- データ取得・検索API (datapoints)
- クエリパラメータにて指定されたプロパティにマッチした情報を返すAPI
- 緯度経度などの地理情報を持たないデータを扱う
- 地物情報取得・検索API (places)
- 地理情報を使った地理領域による絞込機能を提供するAPI
- 緯度経度などの地理情報を持つデータを扱う
以下に本APIドキュメントにおける留意点を述べる。
- 本APIで扱うデータは、全てJSON-LD形式で値を返す。
- それぞれのデータは、Hash形式で表現される
- APIによって出力される結果は全てHashのArrayとして返される
- たとえマッチする結果が1つであったとしても、長さ1のArray（Hashを1つ持ったArray）として返される
- リクエストを行う際のクエリパラメータは、必ずURIエンコードを行った上で送信する必要がある
- 例えば「札幌」は「%E6%9C%AD%E5%B9%8C」とエンコードする必要がある
- 可読性を保つため、本ドキュメントではURIエンコードを行っていない状態で表記している
- リクエスト時には、全てのAPIにおいて次のパラメータを必ず付与する必要がある
- rdf:type : データの種別を表す : rdf:type によってデータ構造が異なる。データ構造は「地物情報（ug:Poi）」「イベント・催し物情報（event:Event）」「スキージャンプ競技情報」「バス情報（Bus）」「鉄道情報（Train）」を参照のこと。
名前空間
このAPI仕様で扱うRDF語彙セットの名前空間として、以下のものを利用する。
| 名前空間 | Identifier | 備考 |
|---|---|---|
| rdf | http://www.w3.org/1999/02/22-rdf-syntax-ns# | RDF |
| rdfs | http://www.w3.org/2000/01/rdf-schema# | RDF Schema |
| dc | http://purl.org/dc/elements/1.1/ | Dublin Core |
| dcterms | http://purl.org/dc/terms/ | DCMI Meta Terms |
| foaf | http://xmlns.com/foaf/0.1/ | FoaF (Friend of Friend) |
| geo | http://www.opengis.net/ont/geosparql# | OGC GeoSPARQL 地理情報記述語彙 |
| owl | http://www.w3.org/2002/07/owl# | W3C Web Obtology Language |
| xsd | http://www.w3.org/2001/XMLSchema-datatypes | XML Schema Datatypes |
| ug | http://uidcenter.org/vocab/ucr/ug# | uID Center 地物に関する語彙セット |
| ugsrv | http://uidcenter.org/vocab/ucr/ugsrv# | uID Center 地理情報サービスに関する語彙セット |
| ugx | http://sapporo.odcity.org/vocab/ugx# | 地物に関する語彙セット 札幌オープンデータ拡張 |
| ugsrvx | http://sapporo.odcity.org/vocab/ugsrvx# | 地理情報サービスに関する語彙セット 札幌オープンデータ拡張 |
| hotel | http://sapporo.odcity.org/vocab/ugx/hotel# | 地物・地理情報サービスに関する語彙セット 札幌オープンデータ拡張 宿泊施設関連拡張 |
| event | http://sapporo.odcity.org/vocab/ugx/event# | 札幌オープンデータ イベント情報語彙 |
| shopping | http://sapporo.odcity.org/vocab/ugx/shopping# | 札幌オープンデータ 買い物情報語彙 |
| skijump | http://sapporo.odcity.org/vocab/skijump# | 札幌オープンデータ スキージャンプ競技情報関連語彙 |
札幌オープンデータAPI で指定可能なrdf:type 一覧
札幌オープンデータAPIでは、下記のデータを取得することが出来る。
| rdf:type | 説明 | 対応API |
|---|---|---|
| ug:Poi およびそのサブクラス |
地物情報 | データ取得・検索API(datapoints), 地物情報取得・検索API(places) |
| sapporo:Event | 催し物・イベント情報 | データ取得・検索API(datapoints) |
| sapporo:Shopping | 買い物情報 | データ取得・検索API(datapoints) |
| 現在非公開 | スキージャンプ・選手情報 | データ取得・検索API(datapoints) |
| odpt:BusroutePattern | バス路線情報 | データ取得・検索API(datapoints) |
| odpt:BusstopPole | バス停情報 | データ取得・検索API(datapoints) |
| odpt:BusstopPoleTimetable | バス停時刻表 | データ取得・検索API(datapoints) |
| odpt:BusroutePatternFare | バス運賃 | データ取得・検索API(datapoints) |
| odpt:StationTimetable | 駅時刻表 | データ取得・検索API(datapoints) |
| odpt:TrainInformation | 列車運行情報 | データ取得・検索API(datapoints) |
| odpt:Train | 列車ロケーション情報 | データ取得・検索API(datapoints) |
| odpt:Station | 駅情報 | データ取得・検索API(datapoints) |
| odpt:PassengerSurvey | 駅乗降人員数 | データ取得・検索API(datapoints) |
| odpt:Railway | 鉄道路線情報 | データ取得・検索API(datapoints) |
| odpt:RailwayFare | 運賃 | データ取得・検索API(datapoints) |
なお、地物情報に関しては、ug:Poi のサブクラスである飲食店（ug:Restaurant）および宿泊施設（ug:Hotel）は、標準的な地ずつの情報に加えて、飲食店や宿泊施設固有の拡張情報を得ることが出来る。
ug:Poi, sapporo:Event, sapporo:Shopping は下図のように相互に参照される。
データ検索・取得API (/api/v1/datapoints?)
# リクエスト例
curl -X GET https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=ug:Hotel
/api/v1/datapoints では、指定したクエリにマッチした情報を返す。
| クエリ | 説明 | 必須 |
|---|---|---|
| rdf:type | 取得するデータの種別を指定します。rdf:type一覧を参照 | ◯ |
| PREDICATE | rdf:typeで指定したクラスの持つブロパティを指定して、フィルタリングを行う |
PREDICATEはrdf:type毎に変化するプロパティ名である。rdf:type毎のプロパティ一覧は「地物情報（ug:Poi）」「イベント・催し物情報（event:Event）」「スキージャンプ競技情報」「バス情報（Bus）」「鉄道情報（Train）」を参照のこと。
フィルター処理
パラメータに PREDICATE を指定することにより、検索結果を特定の値でフィルタリングできる。
例えば地物情報（rdf:typeがug:Poi及びそのサブクラス）のうち、大通公園の情報のみ取得する場合は、ug:Poiの持つdc:titleをPREDICATEに指定して、その値に「大通公園」を指定する。
https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=ug:Poi&dc:title=大通公園
検索条件を複数指定する際には、PREDICATEの値をコンマ “,” 区切りで指定することにより、OR検索を実現できる。
たとえば地物情報について、大通公園と北海道立文学館の情報を一度に取得したい場合は、dc:title に大通公園と北海道立文学館を “,” 区切りで指定して検索する。
https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=ug:Poi&dc:title=大通公園,北海道立文学館
地物情報検索API (/api/v1/places?)
/api/v1/places では、地理情報を用いた領域絞込が可能である。 APIで検索する対象となるデータは、札幌オープンデータAPIにて提供する地物属性を持つ全ての情報となり、地物属性を持たない情報は結果に含まれない。
| クエリ | 説明 | 必須 |
|---|---|---|
| rdf:type | 取得するデータの種別を指定します。rdf:type一覧を参照 | ◯ |
| lat | 取得する範囲の中心緯度を指定、10進数表記 | ◯ |
| lon | 取得する範囲の中心経度を指定、10進数表記 | ◯ |
| radius | 取得する範囲の半径をメートルで指定 | ◯ |
| PREDICATE | rdf:typeで指定したクラスの持つプロパティを指定して、フィルタリングを行う |
PREDICATEはrdf:type毎に変化するプロパティ名である。
# リクエスト例
curl -X GET "https://api-sapporo.odcity.org/api/v1/places?rdf:type=ug:Poi&lon=141.3506029&lat=43.068516&radius=1000"
フィルター処理
PREDICATEのみ、扱いが他のクエリと異なる。これは、rdf:typeにて指定したクラスのメンバを指定することで、特定の値でフィルタリングを行うために利用される。
例えばrdf:typeとしてug:Poiを指定した時、dc:subjectが「お土産」のものを取得したい場合、以下の様なリクエストが可能である。
https://api-sapporo.odcity.org/api/v1/places?rdf:type=ug:Poi&lon=141.3506029&lat=43.068516&radius=1000&dc:subject=お土産
検索条件を複数指定する際には、PREDICATEの値をコンマ “,” 区切りで指定することにより、OR検索を実現できる。
ug:Poiについて、dc:subject が「ラーメン」か「カレー」のデータのみを取得したい場合は、下記のように “,” 区切りで指定する。
https://api-sapporo.odcity.org/api/v1/places?rdf:type=ug:Poi&lon=141.3506029&lat=43.068516&radius=1000&dc:subject=ラーメン,カレー
langクエリによる言語指定
# 言語指定サンプル1. 英語の地物情報を取得する例
curl -X GET "https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=ug:Poi&lang=en"
# 言語指定サンプル1. の応答
[
{
"@context": [
"http://vocab.sapporo.odcity.org/context_Poi.jsonld",
{"@language":"en"}
],
"@id": "urn:ucode:_00001C000000000000010000030C46CD",
"@type": [
"ug:Poi",
"ug:Park"
],
"dc:date": "2015-09-03T11:39:51+09:00",
"dc:title": "Sapporo Odori Park",
...
},
...
]
# 言語指定サンプル2. 対応している全言語の地物情報を取得する例
curl -X GET "https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=ug:Poi&lang=all"
# 言語指定サンプル2. の応答
[
{
"@context": [
"http://vocab.sapporo.odcity.org/context_Poi.jsonld",
{"@language":"ja"}
],
"@id": "urn:ucode:_00001C000000000000010000030C46CD",
"@type": [
"ug:Poi",
"ug:Park"
],
"dc:date": "2015-09-03T11:39:51+09:00",
"dc:title": "大通公園",
...
},
{
"@context": [
"http://vocab.sapporo.odcity.org/context_Poi.jsonld",
{"@language":"en"}
],
"@id": "urn:ucode:_00001C000000000000010000030C46CD",
"@type": [
"ug:Poi",
"ug:Park"
],
"dc:date": "2015-09-03T11:39:51+09:00",
"dc:title": "Sapporo Odori Park",
...
},
...
]
リクエストパラメータ中に言語指定を含めることで、取得対象となる情報を指定した言語で取得することができる。以下にリクエスト例を示す。
| クエリ | 説明 | 必須 |
|---|---|---|
| lang | 取得するデータの言語を指定する。指定する言語コードはISO639に準拠する。全ての言語を出力する場合はallを指定する。 |
langクエリが指定された場合、リテラル表記の文字列を指定された言語に変換（翻訳）して出力を行う。
langクエリにallが指定された場合、保持する全ての言語（翻訳）を返す。
langクエリが指定されなかった場合、又は対応する言語（翻訳）が存在しない場合は翻訳の元となった言語コードでの情報が返される。（現在のところ、この場合は全て日本語:jaで返される）
レスポンスは、@contextを拡張した形で@languageプロパティに言語名を格納して返す。また複数言語の結果が存在する場合は、配列内にそれぞれの言語毎の情報を格納して返す。
地物情報（ug:Poi）
# 中心緯度経度（43.068516, 141.3506029)、半径1000m以内の地物を検索する
curl -X GET "https://api-sapporo.odcity.org/api/v1/places?rdf:type=ug:Poi&lon=141.3506029&lat=43.068516&radius=1000"
[
{
"@context": "http://vocab.sapporo.odcity.org/context_Poi.jsonld",
"@id": "urn:ucode:_00001c00000000000002000000260852",
"@type": ug:Poi",
"geo:long" : 141.3506307,
"geo:lat": 43.0595009,
"dc:title": "大通公園",
"dc:subject": "Event,Sightseeing,Winter,イベント,観光,冬",
"dc:description": "札幌市の中心部にある、大通西1丁目から12丁目までの長さ約1.5kmに渡る大きな公園です。\n雪まつりのイベント会場の1つです。",
"dc:date": "2015-02-14T18:24:06+09:00",
"ugsrv:url": "http://www.sapporo-park.or.jp/"
},
...
]
地物情報 ug:Poiでは、建物、ランドマーク、設置物などの情報を提供する。地物情報は必ず緯度経度情報（geo:long,geo:lat）を持ち、/places APIを使用した地理領域絞り込み検索が可能である。
地物のクラスは ug:Poi をルートとした階層的なクラス構造を持っており、また、場合によっては複数のクラスを継承する場合がある。@typeには複数の地物クラスが列挙される場合があり、その場合、ug:Poiに至るまでの全ての先祖クラスが列挙される。
検索や情報取得のためのエンドポイントは共通であるが、地物のクラスによっては追加で指定可能な検索パラメータや、レスポンスに追加で応答されるプロパティをもつ場合がある。
追加プロパティがある地物クラス
地物情報のうち、飲食店、および宿泊施設に関しては、基本的な地物情報プロパティに追加で、飲食店固有、および宿泊施設固有のプロパティ、及び、固有の検索パラメータを持っている。
これらに関しては、後述の「飲食店（ug:Restaurant）固有のレスポンス」「宿泊施設（ug:Hotel）固有のパラメータ・レスポンス」で説明する。
エンドポイント
データ取得・検索API https://api-sapporo.odcity.org/api/v1/datapoints地物情報取得・検索API https://api-sapporo.odcity.org/api/v1/places
基本パラメータ（データ検索API利用時）
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | ug:Poi およびそのサブクラス |
地物のクラス名。ug:Poi またはそのサブクラスを指定する | ◯ |
| @id | URN | 固有識別子(ucode) | |
| dc:title | xsd:string | 地物名 | |
| dc:subject | xsd:string | 地物のコンテンツに関しての検索・分類用のタグ文字列。 Shopping, Food, Soup Curry など、どのようなタグが付いているかは、オープンデータ生成の元になったデータによって様々である。 |
|
| ug:floor | xsd:double | （ビル内の店舗などの）地物が存在する階数（高さ情報） | |
| ug:address | xsd:string | 住所、地名 | |
| ugsrv:tel | xsd:string | 電話番号（店舗問合せ先など） | |
| ugsrv:url | xsd:string | URL（店舗ホームページなど） | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソースを指定する。 | |
| sapporo:isPartOf | ug:Poi | 地物が他の地物の一部である場合（付帯施設、デパート内の店舗など）、その地物のidを指定する | |
| sapporo:keyword | xsd:string | 地物に設定されたキーワードを指定する。 | |
| sapporo:event | event:Event | 地物で開催されるイベント・催し物のidを指定する | |
| sapporo:shopping | shopping:Shopping | 地物で販売している物品の買い物情報のidを指定する。 | |
| sapporo:hasAnyEvent | xsd:boolean | イベント情報が1つ以上関連づけられているものを検索する | |
| sapporo:hasAnyShopping | xsd:boolean | 買い物情報が1つ以上関連づけられているものを検索する |
基本パラメータ(地物情報検索API利用時)
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | 地物のクラス名。ug:Poi またはそのサブクラスを指定する | ◯ | |
| @id | URN | 固有識別子(ucode) | |
| lat | xsd:double | 検索範囲の中心点の緯度、10進表記 | ◯ |
| lon | xsd:double | 検索範囲の中心点の経度、10進表記 | ◯ |
| radius | xsd:double | 検索範囲の半径(m) | ◯ |
| ug:floor | xsd:double | （ビル内の店舗などの）地物が存在する階数（高さ情報） | |
| dc:title | xsd:string | 地物名 | |
| dc:subject | xsd:string | 地物のコンテンツに関しての検索・分類用のタグ文字列。 Shopping, Food, Soup Curry など、どのようなタグが付いているかは、オープンデータ生成の元になったデータによって様々である。 |
|
| ug:address | xsd:string | 住所、地名 | |
| ugsrv:tel | xsd:string | 電話番号（店舗問合せ先など） | |
| ugsrv:url | xsd:string | URL（店舗ホームページなど） | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソースを指定する。 | |
| sapporo:isPartOf | ug:Poi | 地物が他の地物の一部である場合（付帯施設、デパート内の店舗など）、その地物のidを指定する | |
| sapporo:keyword | xsd:string | 地物に設定されたフリーキーワードを文字列で指定する。 | |
| event:event | sapporo:Event | 地物で開催されるイベント・催し物のidを指定する | |
| sapporo:shopping | shopping:Shopping | 地物で販売している物品の買い物情報のidを指定する。 | |
| sapporo:hasAnyEvent | xsd:boolean | イベント情報が1つ以上関連づけられているものを検索する | |
| sapporo:hasAnyShopping | xsd:boolean | 買い物情報が1つ以上関連づけられているものを検索する |
基本レスポンス
ug:Poi の基本的なレスポンスは以下のものである。
なお@typeがug:Poiのサブクラスとなっている地物の場合、サブクラス固有の追加プロパティを持つ場合がある。
「必須」のプロパティは応答に必ず含まれるプロパティである。それ以外のプロパティは、それが設定されている場合にのみ応答に含まれる。
| プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ |
| @id | URN | 固有識別子 | ◯ |
| @type | rdf:type | 地物のクラス名 | ◯ |
| geo:long | xsd:double | 代表点の経度、10進表記 | ◯ |
| geo:lat | xsd:double | 代表点の緯度、10進表記 | ◯ |
| ug:floor | xsd:double | （ビル内の店舗などの）地物が存在する階数（高さ情報） | |
| dc:date | xsd:dateTime | データ生成時刻 | ◯ |
| dc:title | xsd:string | 地物名 | ◯ |
| ugx:titleKana | xsd:string | 地物名のフリガナ（カタカナ） | |
| dc:subject | xsd:string | 地物のコンテンツに関しての検索・分類用タグを “,” で区切って指定する。 Shopping, Food, Soup Curry など。どのようなタグが付いているかは、オープンデータ生成の元になったデータによって様々である。 |
|
| dc:description | xsd:string | 説明文（施設案内、商品案内など） | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソースを格納する。 | |
| sapporo:isPartOf | ug:Poi | 地物が他の地物の一部である場合（付帯施設、デパート内の店舗など）、その地物のidが設定される | |
| sapporo:hasPart | ug:Poi | 地物に含まれる他の地物（付帯施設、デパート内の店舗など）のidが設定される。sapporo:isPartOf の逆向き関係。 | |
| ug:address | xsd:string | 住所、地名 | |
| ugsrv:zipcode | xsd:string | 郵便番号 | |
| ugsrv:tel | xsd:string | 電話番号（店舗問合せ先など） | |
| ugsrv:fax | xsd:string | FAX番号（店舗問合せ先など） | |
| ugsrv:url | xsd:string | URL（店舗ホームページなど） | |
| ugsrv:email | xsd:string | メールアドレス（店舗問合せ先など） | |
| ugsrvx:acceptedPaymentMethods | ugsrvx:PaymentMethod, ugsrvx:CreditCard | 利用可能な支払い方法 | |
| ugsrvx:acceptedPaymentMethodsText | xsd:string | 支払い方法（テキストでの説明文） | |
| ugsrv:howToAccess | xsd:string | アクセス方法。交通案内 | |
| ugsrvx:openingHours | xsd:string | 定型フォーマットの営業時間、開館時間など。複数存在する場合がある。 | |
| ugsrvx:openingHoursSpecification | ugsrvx:OpeningHoursSpesification | 営業時間、開館時間などの詳細。 ugsrvx:openingHours がある場合は、それに対しての追加・例外の記述となる。 |
|
| ugsrvx:openingHoursText | xsd:string | 営業時間・開館時間などのテキスト表記 | |
| ugsrvx:holidaysText | xsd:string | 定休日、休館日などのテキスト表記 | |
| ugsrv:priceText | xsd:string | 主な商品の料金、入場料、サービス料、利用料、宿泊料などの説明文 | |
| ugsrvx:parkingText | xsd:string | 駐車場情（有無、台数、料金など）の説明文。地物の付属施設として駐車場の場合と、地物自体が駐車場の場合がある。 | |
| ugsrvx:foreignLanguageSupport | xsd:string | 外国語対応の種類。Staff, Guide, Menu の3種類。複数ある場合があり | |
| ugsrvx:foreignLanguageStaff | xsd:string | 外国語対応スタッフの対応言語。ISO639の言語コードで表記する。複数ある場合あり | |
| sapporo:imageUrl | xsd:string | 地物の紹介写真などのURL | |
| sapporo:mapImageUrl | xsd:string | 地物の施設図面・見取り図・案内地図画像などのURL | |
| sapporo:facilityInfoText | xsd:string | 施設の付属設備情報（体育館の設備情報など）の説明文 | |
| sapporo:keyword | xsd:string | 地物に設定されたフリーキーワードを文字列で格納する。 | |
| event:event | sapporo:Event | 地物で開催されるイベント・催し物情報のidが設定される | |
| ugsrvx:numberOfSheats | xsd:integer | （飲食店やイベント施設などの）座席数 | |
| ugsrvx:internetAvailable | xsd:bool | インターネット接続施設の有無 | |
| sapporo:shopping | shopping:Shopping | 地物で販売している物品の買い物情報のidが設定される。 |
支払い方法の種類
ugsrvx:acceptedPaymentMethods は、gr:acceptedPaymentMethods のサブプロパティである。
値域には ugsrvx:PaymentMethod および ugsrvx:CreditCard が利用できる。
ugsrvx:PaymentMethod で定義する支払い方法は以下のとおり。
| @id | 説明 | owl:sameAs（参考） |
|---|---|---|
| ugsrvx:PaymentMethod.Cash | 現金 | gr:Cash |
これ以外に gr:PaymentMethod で定義されている gr:Xxxxx に関しては、ugsrvx:PaymentMethod.Xxxx として同等のものが利用可能である。
また、gr:PaymentMethod で定義されていない支払い方法（Kitakaなど）は、@id を “ugsrvx:PaymentMethod.英語表記（キャメルケース）” として定義を追加していく。
ugsrvx:CreditCard で定義する利用可能クレジットカードは以下のとおり。
| @id | 説明 | owl:sameAs（参考） |
|---|---|---|
| ugsrvx:CreditCard.AmericanExpress | American Express | gr:AmericanExpress |
| ugsrvx:CreditCard.DinersClub | Diners Club | gr:DinersClub |
| ugsrvx:CreditCard.Discover | Discover | gr:Discover |
| ugsrvx:CreditCard.JCB | JCB | gr:JCB |
| ugsrvx:CreditCard.MasterCard | Master Card | gr:MasterCard |
| ugsrvx:CreditCard.VISA | VISA | gr:VISA |
これ以外のクレジットカードは、@id を “ugsrvx:CreditCard.カードの英語表記（キャメルケース）” として定義を追加していく。
# 営業日・休業日の例（１）
{
"@context": "http://vocab.sapporo.odcity.org/context_ug_Poi.jsonld",
"@id": "urn:ucode:_00001c00000000000002000000260852",
"@type": "ug:Poi",
"ugsrvx:openingHours": [
"Tu-Fr 10:00-16:00 LastAdmission=15:30",
"Sa,Su 09:00-17:00 LastAdmission=16:30"
],
"ugsrvx:openingHoursSpecification": [
{
"@type": "ugsrvx:OpeningHoursSpecification",
"schema:validFrom": "2015-12-31",
"schema:validThrough": "2015-12-31",
"schema:opens": "10:00",
"schema:closes": "24:00",
"ugsrvx:openingHoursSpecificationOrder": 1
},
{
"@type": "ugsrvx:OpeningHoursSpecification",
"schema:validFrom": "2015-01-01",
"schema:validThrough": "2015-01-01",
"schema:opens": "00:00",
"schema:closes": "02:00",
"ugsrvx:lastAdmission": "01:30",
"ugsrvx:openingHoursSpecificationOrder": 2
},
{
"@type": "ugsrvx:OpeningHoursSpecification",
"schema:validFrom": "2016-01-01",
"schema:validThrough": "2016-01-05",
"ugsrvx:isClosingTime": true,
"ugsrvx:openingHoursSpecificationOrder": 3
}
],
"ugsrvx:openingHoursText": "火～金 10:00～16:00。土・日 9:00～17:00。大晦日は26時まで営業。（入場は閉館の30分前まで）",
"ugsrvx:holidaysText": "月曜休館。1/1～1/5休館。"
}
# 営業日・休業日の例（２）
{
"@context": "http://vocab.sapporo.odcity.org/context_ug_Poi.jsonld",
"@id": "urn:ucode:_00001c00000000000002000000260852",
"@type": "ug:Poi",
"ugsrvx:openingHours": [
"Mo-Fr 10:00-24:00",
"Tu-Sa 00:00-02:00 LastOrders=01:00",
],
"ugsrvx:openingHoursText": "月～金 10:00～26:00",
"ugsrvx:holidaysText": "土日"
},
ugsrvx:openingHours
ugsrvx:openingHours は http://schema.org/openingHours のサブプロパティとする。
schema:openingHours の概要は以下のとおり。
- 営業時間は、曜日と時間で表現される。
- 曜日はコンマ(,）で区切って列挙する。連続する曜日は ’-’ で区切って、'開始曜日-終了曜日’ として表記できる。
- 開始時刻と終了時刻は ’-’ で区切って表記する。
- 曜日は、月曜から日曜までそれぞれ Mo, Tu, We, Th, Fr, Sa, Su と表記する。
- 時刻は 24 時間制を使う。例えば午後3時は 15:00 と表記する。
- 表記例
- 「水・木曜日 16時から20時まで」は “Tu,Th 16:00-20:00” と表記される。
- 毎日営業で時刻指定がなければ “Mo-Su” と表記される。
ugsrvx:openingHours には飲食店のラストオーダーや、博物館などの最終入場時刻（「入場は○時まで」）のために以下の表記方法を追加する。
- ラストオーダーは schema:openingHours の記述に
LastOrders=16:30のように続ける。 - 最終入場時刻は schema:openingHours の記述に
LastAdmission=16:30のように続ける。- 例：ラストオーダーが 19:30 であれば
Mo-Fr 16:00-20:00 LastOrder=19:30のようになる。
- 例：ラストオーダーが 19:30 であれば
ugsrvx:OpeningHoursSpecification
ugsrvx:OpeningHoursSpecification は http://schema.org/OpeningHoursSpecification のサブクラスとする。
- ラストオーダー・最終入場時刻を示すために ugsrvx:lastOrders および ugsrvx:lastAdmission プロパティを追加する。
- 例外的な休日（年始年末や臨時休業日）や休業時間を示すために ugsrvx:isClosingTime プロパティを追加し、これが true の場合は営業日・営業時間ではなく、休日・休業時間を示すものとする。
- 評価順序を示すための ugsrvx:openingHoursSpecificationOrder プロパティを追加する。
- 日時が指定されたときの営業中かそうでないかの判定は、以下のようになる。
- ugsrvx:openingHours および ugsrvx:openingHoursSpecification のどちらも定義されていない場合は、営業時間に関しての定式化された情報がないので判定しない。（文字列での営業時間・休業日の記述があれば表示はできるが、機械的な判定は出来ない）
- 条件にあう ugsrvx:openingHoursSpecification 記述のうちの、ugsrvx:openingHoursSpeficicationOrder が最小のものを取り上げる。その ugsrvx:isClosingTime が true ならば営業時間外、それ以外は営業時間内である。
- なお、ugsrvx:openingHoursSpeficicationOrder が存在しない場合は評価順が決められないため、機械的な営業時間内判定が出来ない場合がある。
- 条件にあう ugsrvx:openingHoursSpecification が存在しなければ、ugsrvx:openingHours の記述を利用する。ugsrvx:openingHours の記述自体がなければ時間外であるである。
- 日時が指定されたときの営業中かそうでないかの判定は、以下のようになる。
飲食店（ug:Restaurant）固有のパラメータ・レスポンス
レストラン（ug:Restaurant）は ug:Poi のサブクラスであり、基本パラメータ、基本レスポンスに加え、以下のパラメータやプロパティが利用できる。
ug:Restaurant 固有パラメータ（データ検索・地物情報検索API共通）
| ug:Restaurant パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| ugsrvx:foreignMenu | xsd:string | 外国語メニューの対応言語。ISO639の言語コードで指定する。 | |
| ugsrvx:halalCorrespondence | xds:boolean | ハラル対応の有無の指定 |
飲食店（ug:Restaurant）固有のレスポンス
| ug:Restaurant プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| ugsrvx:foreignMenu | xsd:string | 外国語メニューの対応言語。ISO639の言語コード。複数ある場合あり | |
| ugsrvx:halalCorrespondence | xds:boolean | ハラル対応の有無 | |
| ugsrvx:foodLabeling | xsd:boolean | 使用食材表記の有無 |
宿泊施設（ug:Hotel）固有のパラメータ・レスポンス
宿泊施設（ug:Hotel）は ug:Poi のサブクラスであり、基本パラメータ、基本レスポンスに加え、以下のパラメータやプロパティが利用できる。
ug:Hotel 固有レスポンス
| ug:Hotel プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| hotel:bookingUrl | xsd:string | 予約サイトURL | |
| hotel:numOfRooms | xsd:string | 部屋数・宿泊者数の説明。「和室34室（52人）、2室（7人）」など | |
| hotel:checkInTime | xsd:time | チェックイン時刻 | |
| hotel:checkOutTime | xsd:time | チェックアウト時刻 | |
| hotel:rateText | xsd:string | 料金の説明 | |
| hotel:basicRate | hotel:BasicRate | 基本料金（部屋タイプごとに説明がある場合） | |
| hotel:amenityText | xsd:string | アメニティ情報の説明（付帯設備、サービスなど） |
基本料金はまとめての説明が hotel:rateText、部屋タイプごとに説明がある場合は hotel:rateText で表記される。情報源によって、片方だけの場合、両方ある場合、料金情報がない場合がある。
hotel:basicRate は以下のデータ構造になり、必要な数だけ列挙される。
| hotel:basicRate プロパティ | 値域 | 説明 |
|---|---|---|
| hotel:roomType | xsd:string | 部屋タイプ |
| hotel:rateText | xsd:string | 料金の説明文 |
| hotel:sortOrder | xsd:integer | 表示順。この指定がある場合は小さい順に並べて表示する。 |
イベント・催し物情報（event:Event）
イベント・催し物情報 event:Event では、イベントや催し物の情報を提供する。
イベントが複数の会場に分かれて開催される場合や、大規模・長期間のイベントの中で開催される小さなイベントなどを表現するため、event:hasPart や event:isPartOf によって階層を作ることが出来る。
エンドポイント
データ取得・検索API https://api-sapporo.odcity.org/api/v1/datapoints
基本パラメータ（データ検索API利用時）
# イベント・催し物情報を取得する。
curl -X GET "https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=event:Event"
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | クラス指定。event:Event で固定。 | ◯ | |
| @id | URN | 固有識別子(ucode) | |
| dc:title | xsd:string | イベント・催し物名 | |
| dc:subject | xsd:string | 検索用のタグ文字列 | |
| dc:description | xsd:string | 説明文 | |
| ugsrv:url | xsd:string | URL（イベントのホームページなど） | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソース | |
| event:isPartOf | event:Event | あるイベントのサブイベント（大きなイベント中の個々の会場、長期・大規模なイベントの間の個々の小さなイベントなど）を検索する場合、そのイベントのidを指定する |
レスポンス
[
{
"@context": "http://vocab.sapporo.odcity.org/context_Event.jsonld",
"@id": "urn:ucode:_00001c00000000000002000000260852",
"@type": "event:Event",
"dc:title": "さっぽろ雪まつり",
"dc:subject": "Winter,Snow,冬,雪",
"dc:description": "さっぽろ雪まつりは、大通会場、すすきの会場、つどーむ会場の3会場で開催されます。",
"dc:date": "2015-02-14T18:24:06+09:00",
"dc:source": "http://www.welcome.city.sapporo.jp/event/winter/sapporo_snow_festival/",
"ugsrv:url": "http://www.snowfes.com/",
"ugsrv:tel": "011-281-6400（さっぽろ雪まつり実行委員会）※すすきの氷の祭典への問い合わせは、一般社団法人すすきの観光協会 011-518-2005",
"ugsrvx:openingHoursSpecification": {
"@type": "ugsrvx:OpeningHoursSpecification",
"schema:validFrom": "2016-02-05",
"schema:validThrough": "2016-02-11"
},
"ugsrvx:openingHoursText": "2016年2月5日（金曜日）～11日（木曜日・祝日）",
"event:eventVenue": [
"urn:ucode:_00000000000000000000000000000001",
"urn:ucode:_00000000000000000000000000000002",
"urn:ucode:_00000000000000000000000000000003"
],
"event:hasPart": [
"urn:ucode:_0000000000000000000000000000000b",
"urn:ucode:_0000000000000000000000000000000c",
"urn:ucode:_0000000000000000000000000000000d"
]
},
...
]
event:Event のレスポンスは以下のものである。
「必須」のプロパティは応答に必ず含まれるプロパティである。それ以外のプロパティは、それが設定されている場合にのみ応答に含まれる。
| event:Event プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ |
| @id | urn: | 固有識別子 | ◯ |
| @type | rdf:type | クラス名。event:Event で固定 | ◯ |
| dc:date | xsd:dateTime | データ生成時刻 | ◯ |
| dc:title | xsd:string | イベント・催し物名 | ◯ |
| dc:subject | xsd:string | 検索・分類用のタグ文字列。",“ で区切って列挙される | |
| dc:description | xsd:string | 説明文 | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソースを格納する。 | |
| ugsrv:url | xsd:string | イベントホームページなどのURL | |
| ugsrv:tel | xsd:string | イベント問合せ電話番号 | |
| ugsrv:howToAccess | xsd:string | アクセス方法。交通案内 | |
| ugsrv:priceText | xsd:string | 主な商品の料金、入場料、サービス料、利用料、宿泊料などのテキスト表記 | |
| ugsrvx:openingHours | xsd:string | 定型フォーマットの開催時間 | |
| ugsrvx:openingHoursSpecification | ugsrvx:OpeningHoursSpesification | 開催時間の詳細。openingHours への追加・例外を記述する。 | |
| ugsrvx:openingHoursText | xsd:string | 開催時間のテキスト表記 | |
| ugsrvx:holidaysText | xsd:string | イベントの休みのテキスト表記 | |
| event:eventApplication | xsd:string | 参加方法・申し込み方法の説明 | |
| event:eventVenue | ug:Poi | 開催場所。IDでリストされる | |
| event:isPartOf | event:Event | イベントが他のイベントの一部である場合（大きなイベント中の会場の1つ、長期・大規模なイベントの間の個々の小さなイベントなど）、そのイベントのidが格納される | |
| event:hasPart | event:Event | イベント内でのサブイベントのidが格納される。event:isPartOf の逆向き関係。 |
開催期間 ugsrvx:openingHours, ugsrvx:openingHoursSpecification, ugsrvx:openingHoursText, ugsrvx:holidays の説明は ug:Poi の基本レスポンスの説明を参照のこと。
買い物情報報（shopping:Shopping）
買い物情報 shopping:Shopping では、名産品・特産品、ご当地グルメなどの情報を取り扱う。
これにより、商品の簡単な紹介や、商品ホームページ、取り扱い店舗などの情報を得ることが出来る。
エンドポイント
データ取得・検索API https://api-sapporo.odcity.org/api/v1/datapoints
基本パラメータ（データ検索API利用時）
# 買い物情報を取得する
curl -X GET "https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=shopping:Shopping"
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | クラス指定。shopping:Shopping で固定。 | ◯ | |
| @id | URN | 固有識別子(ucode) | |
| dc:title | xsd:string | 買い物情報のタイトル。（商品名など） | |
| dc:subject | xsd:string | 検索用のタグ文字列 | |
| dc:description | xsd:string | 説明文 | |
| ugsrv:url | xsd:string | URL（商品のホームページなど） | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソース | |
| ug:poi | ug:Poi | 商品の販売店のpoiリソースのidを指定 |
レスポンス
[
{
"@context": "http://vocab.sapporo.odcity.org/context_Shopping.jsonld",
"@id": "urn:ucode:_00001c00000000000002000000260852",
"@type": "shopping:Shopping",
"dc:date": "2015-02-14T18:24:06+09:00",
"dc:title": "名物○○まんじゅう",
"dc:subject": "スイーツ,和菓子",
"dc:description": "あんこのたっぷり詰まった名産品です。",
"ugsrv:priceText": "6個入り800円、10個入り1000円",
"ugsrv:url": "http://example.com/homepage.html",
"dc:source": "http://example.com/source.html",
"ug:poi": [
{
"@id": "urn:ucode:_0000...00001",
"dc:title": "本家○○まんじゅう"
}
{
"@id": "urn:ucode:_0000...00002",
"dc:title": "元祖○○まんじゅう"
},
{
"@id": "urn:ucode:_0000...00003",
"dc:title": "○○まんじゅう駅前店"
}
]
},
...
]
| プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | shopping:Shopping | クラス。shopping:Shopping で固定。 | ◯ |
| @id | URN | 固有識別子(ucode) | |
| dc:date | xsd:dateTime | データ生成日時 | ◯ |
| dc:title | xsd:string | 買い物情報のタイトル。（商品名など） | |
| dc:subject | xsd:string | 検索・分類用のタグ文字列。",“ で区切って列挙される | |
| dc:description | xsd:string | 説明文 | |
| ugsrv:priceText | xsd:string | 価格説明 | |
| ugsrv:url | xsd:string | URL（商品のホームページなど） | |
| dc:source | xsd:string | 札幌オープンデータの取り込み元ソース | |
| ug:poi | ug:Poi | 商品の販売店のpoiリソース。idと名称を含む。複数あり得る |
スキージャンプ競技情報
スキージャンプ競技について、選手の情報を取得するためのAPIである。
現在非公開
データ取得・検索APIは https://api-sapporo.odcity.org/api/v1/datapoints であり、rdf:type は以下のものを指定する。
| rdf:type | 情報 |
|---|---|
| 現在非公開 | 選手情報 |
選手情報
# 選手情報
[
{
"@context": "http://vocab.sapporo.odcity.org/context_Skijump.jsonld",
"@id": "urn:ucode:_xxxxx",
"@type": "現在非公開",
"dc:date": "2015-10-10 12:00:00",
"skijump:fisCode": 1234,
"skijump:status": "Active",
"skijump:nation": "JPN",
"skijump:birthdate": "1990-01-01",
"skijump:birthPlace": "Hokkaido",
"skijump:languages": "ja",
"skijump:team": "National Team",
"skijump:equipment": [
{
"skijump:equipmentName": "Skis",
"skijump:equipmentManufactuer": "Some Maker"
},
{
"skijump:equipmentName": "Bindings",
"skijump:equipmentManufactuer": "Some Maker"
}
],
"foaf:name": "Ichro Tanaka",
"foaf:givenName": "Ichiro",
"foaf:familyName": "Tanaka",
"foaf:gender": "male",
"foaf:birthday": "01-01",
"foaf:age": "25",
"foaf:depiction": "http://data.fis-ski.com/../ichiro-tanaka.png",
"skijump:result": [
{
"dc:date": "YYYY-MM-DD",
"skijump:place": "FrenstatpodRadhostem",
"skijump:nation": "CZE",
"skijump:category": "ContinentalCup",
"skijump:discipline": "HS106",
"skijump:position": "36",
"skijump:fisPoint": ""
},
:
]
},
:
]
選手の名前、所属、最近の戦績などの個人プロフィールを取得する。
データ取得・検索API https://api-sapporo.odcity.org/api/v1/datapoints
リクエストパラメータ
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | クラス指定。現在非公開 | ○ | |
| @id | URN | 固有識別子(ucode) |
フィルター処理により検索結果を特定の値でフィルタリングできる。
レスポンス
選手プロフィールは、foaf:Person をベースとし、選手プロフィールに必要な情報を拡張した 現在非公開 クラスのデータとして定義する。
| プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ |
| @id | urn: | 固有識別子 | ◯ |
| @type | rdf:type | クラス名。現在非公開 | ◯ |
| dc:date | xsd:dateTime | データ生成時刻 | ○ |
| foaf:name | xsd:string | 選手名 | ○ |
| foaf:givenName | xsd:string | 選手名（名） | |
| foaf:familyName | xsd:string | 選手名（姓） | |
| foaf:gender | xsd:string | 性別。male または female | ○ |
| foaf:birthday | xsd:gMonthDay | 誕生日。 foaf:birthday は月日だけの “mm-dd” 表記 |
|
| foaf:age | xsd:integer | 年齢 | |
| foaf:depiction | xsd:string | 選手写真のURL | |
| skijump:fisCode | xsd:integer | FIS code | ○ |
| skijump:status | xsd:string | ‘Active’ または空文字列 | ○ |
| skijump:nation | xsd:string | 国。ISO 3166-1 alpha-3 の3文字コード | ○ |
| skijump:birthdate | xsd:date | 生年月日。"YYYY-MM-DD" の文字列 | |
| skijump:birthPlace | xsd:string | 出身地 | |
| skijump:languages | xsd:string | 使用言語。ISO 639-1 のコードを利用する | |
| skijump:residence | xsd:string | 居住地 | |
| skijump:maritalStatus | xsd:string | 既婚・未婚 | |
| skijump:skiClub | xsd:string | 所属クラブ | |
| skijump:clubnation | xsd:string | 所属クラブの国 | |
| skijump:team | xsd:string | チーム | |
| skijump:equipment | skijump:EquipmentInformation | 道具の種類とメーカー情報。複数の場合あり | |
| skijump:result | skijump:Result | 最近の戦績情報のリスト |
skijump:EquipmentInformation
道具の種類とメーカーを格納する。
| プロパティ | 値域 | 意味 |
|---|---|---|
| skijump:equipmentName | xsd:string | 種類。"Skis", “Bindings” など |
| skijump:equipmentManufacturer | xsd:string | メーカー |
skijump:Result
戦績情報が格納される。
| プロパティ | 値域 | 意味 |
|---|---|---|
| dc:date | xsd:Date | 競技開催日。YYYY-MM-DD |
| skijump:place | xds:string | 開催地 |
| skijump:nation | xsd:string | 開催国。ISO 639-1 のコードを使う |
| skijump:category | xsd:string | 大会の種別。WorldCup, ContinentalCup など |
| skijump:discipline | xsd:string | 種目 |
| skijump:position | xsd:string | 順位 |
| skijump:fisPoint | xsd:integer | FISポイント |
skijump:position には以下のいずれかが格納される。
- 順位の数値を文字列で表記したもの。"1", “2”, “3”,…
- “DNF” : Do Not Finish（途中棄権）
- “DNS” : Do Not Start（スタート前の棄権）
- “DSQ” : Disqualified（失格）
バス情報（Bus）
バス路線情報 odpt:BusroutePattern
# 路線名が'１８８'であるバス路線情報を取得する
$ curl -X GET "https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:BusroutePattern&dc:title=１８８"
[
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusroutePattern.jsonld",
"@id": null,
"@type": "odpt:BusroutePattern",
"owl:sameAs": "odpt.BusroutePattern:HokkaidoChuo.188.540530.1",
"dc:date": "2015-11-05T15:38:33+09:00",
"dc:title": "１８８",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:busroute": "odpt.Busroute:HokkaidoChuo.188",
"odpt:pattern": "540530",
"odpt:direction": "1",
"ug:region": null,
"odpt:busstopPoleOrder": [
{
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405.2",
"odpt:index": 1,
"odpt:note": "札幌駅北口:540405:札幌駅北口:2"
},
{
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:index": 2,
"odpt:note": "サッポロビール園:541504:サッポロビール園:"
}
],
"odpt:note": "１８８:札幌駅北口→サッポロビール園:540530:1",
"dct:valid": "2015-12-01T00:00:00+09:00"
},
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusroutePattern.jsonld",
"@id": null,
"@type": "odpt:BusroutePattern",
"owl:sameAs": "odpt.BusroutePattern:HokkaidoChuo.188.540531.2",
"dc:date": "2015-11-05T15:38:33+09:00",
"dc:title": "１８８",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:busroute": "odpt.Busroute:HokkaidoChuo.188",
"odpt:pattern": "540531",
"odpt:direction": "2",
"ug:region": null,
"odpt:busstopPoleOrder": [
{
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:index": 1,
"odpt:note": "サッポロビール園:541504:サッポロビール園:"
},
{
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405.",
"odpt:index": 2,
"odpt:note": "札幌駅北口:540405:札幌駅北口:"
}
],
"odpt:note": "１８８:サッポロビール園→札幌駅北口:540531:2",
"dct:valid": "2015-12-01T00:00:00+09:00"
}
]
バス路線情報 odpt:BusroutePatternは、バス路線の情報を示す。この情報は国土交通省国土数値情報を元に構築されているが、 バス路線名称、停車バス停情報、路線形状情報などを加筆・修正したものとなる。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ（データ取得・検索API）
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | odpt:BusroutePattern | バス停時刻表を表すクラスodpt:BusroutePatternを指定する。 | ◯ |
| @id | URN | 固有識別子（ucode） | |
| owl:sameAs | URL | バス路線の固有識別子。 | |
| dc:title | xsd:string | バス路線名 | |
| odpt:operator | odpt:Operator | 運営会社を表すIDを指定する。 |
レスポンス
| 第1階層 | 第2階層 | 値域 | 説明 | 必須 |
|---|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ | |
| @id | URN | 固有識別子 | ◯ | |
| @type | rdf:type | 地物のクラス名, odpt:BusroutePatternが入る | ◯ | |
| owl:sameAs | URL | バス路線の固有識別子。 | ◯ | |
| dc:date | xsd:dateTime | データ生成時刻、e.g. 2013–01–13T15:10:00+09:00、ISO8601形式 | ◯ | |
| dc:title | xsd:string | バス路線（系統）名 | ◯ | |
| odpt:operator | odpt:Operator | 運営会社を表すIDを格納する。 | ◯ | |
| odpt:busroute | xsd:string | 系統を表すID | ||
| odpt:pattern | xsd:string | 系統内種別（e.g. 系統パターンコード） | ||
| odpt:direction | xsd:string | 方向（e.g. 上下区分コード） | ||
| ug:region | odpt:GeoDocument | 地物情報へのURL | ◯ | |
| odpt:busstopPoleOrder | Array | バス路線が停車するバス停のリストを停車順等と共に格納する。 | ◯ | |
| odpt:busstopPole | odpt:BusstopPole | 停車するバス停を表すIDを格納する。IDには、odpt:BusstopPoleのowl:sameAsの値を利用する。 | ◯ | |
| odpt:index | xsd:integer | バス停の停車順序 | ◯ | |
| odpt:nonOperationDay | odpt:Day | バス停に停車しない曜日がある場合は格納する。odpt:Dayは次のいずれかである。odpt.Day:Weekday, odpt.Day:Holiday, odpt.Day:Sunday, odpt.Day:Monday, odpt.Day:Tuesday, odpt.Day:Wednesday, odpt.Day:Thursday, odpt.Day:Friday, odpt.Day:Saturday, odpt.Day:WeekendAndHoliday（土日祝） | ||
| odpt:condition | odpt:Condition | 往路のみ停車（odpt.Condition:OutwardOnly）、復路のみ停車（odpt.Condition:InwardOnly）の場合は格納する。 | ||
| odpt:note | xsd:string | 注記（注記が存在する場合のみ格納する） | ||
| odpt:note | xsd:string | 注記（注記が存在する場合のみ格納する） | ||
| odpt:source | Array(mlit:Busroute) | 元となったmlit:BusrouteのIDの配列。IDにはmlit:Busrouteの@idの値を利用する。 | ||
| dct:valid | xsd:dateTime | データ保証期限、e.g. 2015-12-01T00:00:00+09:00、ISO8601形式 期限が存在する場合のみ格納する |
バス停情報 odpt:BusstopPole
# 札幌ビール園バス停を取得する
$ curl -X "GET https://api.odpt.org/api/v3/datapoints?rdf:type=odpt:BusstopPole&dc:title=サッポロビール園"
[
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusstopPole.jsonld",
"@id": null,
"@type": "odpt:BusstopPole",
"owl:sameAs": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"dc:date": "2015-11-05T15:37:15+09:00",
"dc:title": "サッポロビール園",
"geo:long": 141.36712496,
"geo:lat": 43.07178983,
"ug:region": null,
"odpt:busroutePattern": [
"odpt.BusroutePattern:HokkaidoChuo.188.540530.1",
"odpt.BusroutePattern:HokkaidoChuo.188.540531.2",
"odpt.BusroutePattern:HokkaidoChuo.Junkan88.540467.1"
],
"odpt:operator": [
"odpt.Operator:HokkaidoChuo"
],
"odpt:busstopPoleNumber": "",
"odpt:busstopTimetable": [
"odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Holiday",
"odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Saturday.Even",
"odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Saturday.Odd",
"odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Weekday",
"odpt.BusstopPoleTimetable:HokkaidoChuo.Junkan88.540467.Sapporobi-ruen..Sapporobi-ruen.Holiday",
"odpt.BusstopPoleTimetable:HokkaidoChuo.Junkan88.540467.Sapporobi-ruen..Sapporobi-ruen.Saturday.Even",
"odpt.BusstopPoleTimetable:HokkaidoChuo.Junkan88.540467.Sapporobi-ruen..Sapporobi-ruen.Saturday.Odd",
"odpt.BusstopPoleTimetable:HokkaidoChuo.Junkan88.540467.Sapporobi-ruen..Sapporobi-ruen.Weekday"
],
"odpt:note": "サッポロビール園:541504",
"dct:valid": "2015-12-01T00:00:00+09:00"
}
]
バス停情報 odpt:BusstopPoleは、バス停の情報を示す。この情報は国土交通省国土数値情報を元に構築されているが、 バス停名称、時刻表、位置情報などを加筆・修正したものとなる。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | odpt:BusstopPole | バス停時刻表を表すクラスodpt:BusstopPoleを指定する。 | ◯ |
| @id | URN | 固有識別子（ucode） | |
| owl:sameAs | URL | バス停の固有識別子。 | |
| dc:title | xsd:string | バス停名 | |
| odpt:busstopPoleNumber | xsd:String | バス停標柱番号 | |
| odpt:busroutePattern | odpt:BusroutePattern | 入線するバス路線のID。IDにはodpt:BusroutePatternのowl:sameAsの値を利用する。 | |
| odpt:operator | odpt:Operator | 入線するバスの運営会社を表すID。IDにはodpt:Operatorのowl:sameAsの値を利用する。 |
レスポンス
| odpt:BusstopPole プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ |
| @id | URN | 固有識別子(ucode) | ◯ |
| @type | odpt:BusstopPole | 地物のクラス名、odpt:BusstopPoleが入る | ◯ |
| owl:sameAs | URL | バス停の固有識別子。e.g. ‘odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.’ | ◯ |
| dc:date | xsd:dateTime | データ生成時刻、e.g. 2013–01–13T15:10:00+09:00、ISO8601形式 | ◯ |
| dc:title | xsd:string | バス停名 | ◯ |
| geo:long | xsd:double | 代表点の経度、10進表記 | ◯ |
| geo:lat | xsd:double | 代表点の緯度、10進表記 | ◯ |
| ug:region | odpt:GeoDocument | 地物情報へのURL | ◯ |
| odpt:busroutePattern | Array(odpt:BusroutePattern) | 入線するバス路線のIDの配列。IDにはodpt:BusroutePatternのowl:sameAsの値を利用する。 | ◯ |
| odpt:operator | Array(odpt:Operator) | 入線するバスの運営会社を表すIDの配列。IDにはodpt:Operatorのowl:sameAsの値を利用する。 | ◯ |
| odpt:busstopPoleNumber | xsd:String | バス停標柱番号 | |
| odpt:busstopTimetable | Array(odpt:BusstopPoleTimetable) | バス停の時刻表を表すIDの配列。IDにはodpt:BusstopPoleTimetableのowl:sameAsの値を利用する。 | ◯ |
| odpt:source | Array(mlit:Busstop) | 元となったmlit:BusstopのIDの配列。IDにはmlit:Busstopの@idの値を利用する。 | |
| dct:valid | xsd:dateTime | データ保証期限、e.g. 2015-12-01T00:00:00+09:00、ISO8601形式 期限が存在する場合のみ格納する |
バス停時刻表 odpt:BusstopPoleTimetable
# 札幌ビール園バス停の188路線（odpt.Busroute:HokkaidoChuo.188）の時刻表を取得する。
$ curl -X GET "https://api.odpt.org/api/v3/datapoints?rdf:type=odpt:BusstopPoleTimetable&odpt:busstopPole=odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.&odpt:busroute=odpt.Busroute:odpt.Busroute:HokkaidoChuo.188"
[
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusstopPoleTimetable.jsonld",
"@id": null,
"@type": "odpt:BusstopPoleTimetable",
"owl:sameAs": "odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Weekday",
"dc:date": "2015-11-05T15:13:15+09:00",
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:busDirection": "odpt.BusDirection:HokkaidoChuo.Sapporoekikitaguchi",
"odpt:busroute": "odpt.Busroute:HokkaidoChuo.188",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:calendar": "odpt.Calendar:Weekday",
"odpt:busstopPoleTimetableObject": [
{
"odpt:departureTime": "10:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "11:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "11:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "12:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "12:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "13:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "13:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "14:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "14:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "15:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "15:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "16:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "16:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "17:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "17:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "18:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "18:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "19:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "19:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "20:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "20:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "21:15",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "21:45",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
},
{
"odpt:departureTime": "22:25",
"odpt:destinationBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405."
}
],
"dc:title": "１８８:サッポロビール園→札幌駅北口:サッポロビール園:札幌駅北口:平日",
"dct:valid": "2015-12-01T00:00:00+09:00"
},
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusstopPoleTimetable.jsonld",
"@id": null,
"@type": "odpt:BusstopPoleTimetable",
"owl:sameAs": "odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Holiday",
"dc:date": "2015-11-05T15:13:15+09:00",
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:busDirection": "odpt.BusDirection:HokkaidoChuo.Sapporoekikitaguchi",
"odpt:busroute": "odpt.Busroute:HokkaidoChuo.188",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:calendar": "odpt.Calendar:Holiday",
"odpt:busstopPoleTimetableObject": [...],
"dc:title": "１８８:サッポロビール園→札幌駅北口:サッポロビール園:札幌駅北口:日曜・祝日",
"dct:valid": "2015-12-01T00:00:00+09:00"
},
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusstopPoleTimetable.jsonld",
"@id": null,
"@type": "odpt:BusstopPoleTimetable",
"owl:sameAs": "odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Saturday.Odd",
"dc:date": "2015-11-05T15:13:15+09:00",
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:busDirection": "odpt.BusDirection:HokkaidoChuo.Sapporoekikitaguchi",
"odpt:busroute": "odpt.Busroute:HokkaidoChuo.188",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:calendar": "odpt.Calendar:Saturday.Odd",
"odpt:busstopPoleTimetableObject": [...],
"dc:title": "１８８:サッポロビール園→札幌駅北口:サッポロビール園:札幌駅北口:第1・3・5土曜",
"dct:valid": "2015-12-01T00:00:00+09:00"
},
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusstopPoleTimetable.jsonld",
"@id": null,
"@type": "odpt:BusstopPoleTimetable",
"owl:sameAs": "odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Saturday.Even",
"dc:date": "2015-11-05T15:13:15+09:00",
"odpt:busstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:busDirection": "odpt.BusDirection:HokkaidoChuo.Sapporoekikitaguchi",
"odpt:busroute": "odpt.Busroute:HokkaidoChuo.188",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:calendar": "odpt.Calendar:Saturday.Even",
"odpt:busstopPoleTimetableObject": [...],
"dc:title": "１８８:サッポロビール園→札幌駅北口:サッポロビール園:札幌駅北口:第2・4土曜",
"dct:valid": "2015-12-01T00:00:00+09:00"
}
]
バスの出発時刻を、バス停毎に提供する。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | odpt:BusstopPoleTimetable | バス停時刻表を表すクラスodpt:BusstopPoleTimetableを指定する。 | ◯ |
| @id | URN | 固有識別子（ucode） | |
| owl:sameAs | URL | 固有識別子。 | |
| odpt:busstopPole | odpt:BusstopPole | バス停を表すIDを格納する。IDにはodpt:BusstopPoleのowl:sameAsを利用する。 e.g. 'odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.’ | |
| odpt:busDirection | odpt:BusDirection | 方面を表すIDを指定する。 | |
| odpt:busroute | xsd:string | 路線を表すIDを指定する。 | |
| odpt:operator | odpt:Operator | 運行会社を表すIDを指定する。 |
レスポンス
| odpt:BusstopPoleTimetable プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ |
| @id | URN | 固有識別子（ucode） | ◯ |
| @type | odpt:BusstopPoleTimetable | バス停時刻表を表すクラスodpt:BusstopPoleTimetableを格納する。 | ◯ |
| owl:sameAs | URL | 固有識別子。e.g. 'odpt.BusstopPoleTimetable:HokkaidoChuo.188.540531.Sapporobi-ruen..Sapporoekikitaguchi.Weekday’ | ◯ |
| dc:title | xsd:string | 系統名、停留所名、行き先、経由地、曜日区分等を含む文字列 | |
| dc:date | xsd:dateTime | データ生成時刻、e.g. 2013–01–13T15:10:00+09:00、ISO8601形式 | ◯ |
| odpt:busstopPole | odpt:BusstopPole | バス停を表すIDを格納する。IDにはodpt:BusstopPoleのowl:sameAsの値を利用する。 | ◯ |
| odpt:busDirection | odpt:BusDirection | 方面を表すIDを格納する。 | ◯ |
| odpt:busroute | xsd:string | 路線を表すIDを格納する。 | ◯ |
| odpt:operator | odpt:Operator | 運行会社を表すIDを格納する。 | ◯ |
| odpt:calendar | odpt:Calendar | 運行する曜日・日付（odpt:Calendar）を記載する | ◯ |
| odpt:busstopPoleTimetableObject | Array(odpt:BusstopPoleTimetableObject) | 時刻表を格納する。 | |
| dct:valid | xsd:dateTime | データ保証期限。e.g. 2015-12-01T00:00:00+09:00、ISO8601形式 |
| odpt:BusstopPoleTimetableObject プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| odpt:departureTime | odpt:Time | バス発着時刻をISO8601時刻形式で格納する。 | ◯ |
| odpt:destinationBusstopPole | odpt:BusstopPole | 行先を表すバス停のIDを格納する。IDにはodpt:BusstopPoleのowl:sameAsを利用する。 | ◯ |
| odpt:isNonStepBus | xsd:boolean | ノンステップバスか否か。 | |
| odpt:note | string | 通常と異なる行き先等の注記 |
バス運賃 odpt:BusroutePatternFare
２停留所間の運賃を表す。
# 北海道中央バスの路線１８８のサッポロビール園から札幌駅北口までの運賃を取得する
$ curl -X GET "https://api.odpt.org/api/v3/datapoints?rdf:type=odpt:BusroutePatternFare&odpt:fromBusstopPole=odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.&odpt:toBusstopPole=odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405.2"
[
{
"@context": "http://vocab.sapporo.odcity.org/context_odpt_BusroutePatternFare.jsonld",
"@id": null,
"@type": "odpt:BusroutePatternFare",
"owl:sameAs": "odpt.BusroutePatternFare:HokkaidoChuo.188.540530.1.Sapporobi-ruen.541504..HokkaidoChuo.188.540530.1.Sapporoekikitaguchi.540405.2",
"dc:date": "2015-11-05T15:38:48+09:00",
"odpt:operator": "odpt.Operator:HokkaidoChuo",
"odpt:fromBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporobi-ruen.541504.",
"odpt:toBusstopPole": "odpt.BusstopPole:HokkaidoChuo.Sapporoekikitaguchi.540405.2",
"odpt:ticketFare": 210,
"dct:valid": "2015-12-01T00:00:00+09:00"
}
]
パラメータ
| odpt:BusroutePatternFare プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | odpt:BusroutePatternFare | 運賃を表すクラスであるodpt:BusroutePatternFare | ◯ |
| @id | URN | 固有識別子(ucode) | |
| owl:sameAs | URL | 固有識別子 | |
| dc:date | xsd:dateTime | データ生成日時（ISO8601 日付時刻形式） | |
| odpt:operator | odpt:Operator | 運行会社を表すID | |
| odpt:fromBusstopPole | odpt:BusstopPole | 乗車バス停を表すID。IDには odpt:BusstopPole の owl:sameAs を利用する | |
| odpt:toBusstopPole | odpt:BusstopPole | 降車バス停表すID。IDには odpt:BusstopPole の owl:sameAs を利用する | |
| odpt:tickerFare | xsd:integer | 切符利用時の運賃 | |
| odpt:childCickerFare | xsd:integer | 切符利用時の子供運賃。 | |
| odpt:icCardFare | xsd:integer | ICカード利用時の運賃。 | |
| odpt:icCardChildFare | xsd:integer | ICカード利用時の子供運賃。 |
レスポンス
| odpt:BusroutePatternFare プロパティ | 値域 | 説明 | 必須 |
|---|---|---|---|
| @context | URL | JSON-LD仕様に基づく @context のURL | ◯ |
| @id | URN | 固有識別子（ucode） | ◯ |
| @type | odpt:BusroutePatternFare | バス停時刻表を表すクラスodpt:BusstopPoleTimetableを格納する。 | ◯ |
| owl:sameAs | URL | 固有識別子 | ◯ |
| dc:date | xsd:dateTime | データ生成日時（ISO8601 日付時刻形式） | ◯ |
| odpt:operator | odpt:Operator | 運行会社を表すID | ◯ |
| odpt:fromBusstopPole | odpt:BusstopPole | 乗車バス停を表すID。IDには odpt:BusstopPole の owl:sameAs を利用する | ◯ |
| odpt:toBusstopPole | odpt:BusstopPole | 降車バス停表すID。IDには odpt:BusstopPole の owl:sameAs を利用する | ◯ |
| odpt:tickerFare | xsd:integer | 切符利用時の運賃 | ◯ |
| odpt:childCickerFare | xsd:integer | 切符利用時の子供運賃。 | |
| odpt:icCardFare | xsd:integer | ICカード利用時の運賃。 | |
| odpt:icCardChildFare | xsd:integer | ICカード利用時の子供運賃。 | |
| dct:valid | xsd:dateTime | データ保証期限。e.g. 2015-12-01T00:00:00+09:00、ISO8601形式 |
鉄道情報（Train）
駅時刻表 odpt:StationTimetable
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:StationTimetable&odpt:station=odpt.Station:SapporoCitySubway.Tozai.Miyanosawa'
[
{
"odpt:index": 1,
"odpt:stationTitle": "宮の沢(T01)",
"odpt:station": "odpt.Station:SapporoCitySubway.Tozai.Miyanosawa",
"odpt:id": 920017,
"odpt:operatorTitle": "札幌市営地下鉄",
"odpt:operator": "odpt.Operator:SapporoCitySubway",
"odpt:railwayTitle": "東西線",
"odpt:railway": "odpt.Railway:SapporoCitySubway.Tozai",
"odpt:railDirectionTitle": "(1)宮の沢(T01)→大通(T09)→新さっぽろ(T19)",
"odpt:railDirection": "odpt.RailwayDirection:Outbound",
"odpt:calendarTitle": "平日",
"odpt:calendar": "odpt.Calendar:Weekday",
"dc:date": "2015-10-28T01:50:43+09:00",
"@type": "odpt:StationTimetable",
"@context": "http://vocab.sapporo.odcity.org/context_odpt_StationTimetable.jsonld",
"owl:sameAs": "odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Outbound.Weekday",
"odpt:stationTimetableObject": [
{
"odpt:departureTime": "06:00"
},
{
"odpt:departureTime": "06:10"
}]
}
]
駅時刻表を示す。ターゲットとなる列車の平日、土曜、休日の列車着時刻、発車時刻と種別を示す。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 必須 | 説明 |
|---|---|---|---|
| rdf:type | odpt:StationTimetable | ◯ | クラス指定 |
| @id | URN | 固有識別子(ucode) | |
| owl:sameAs | URL | 固有識別子。命名ルールは、odpt.StationTimetable:会社名.路線名.駅名.方面名 である。 | |
| odpt:station | odpt:Station | 駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:railway | odpt:Railway | 路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 | |
| odpt:operator | odpt:Operator | 運行会社を表すID。 | |
| odpt:railDirection | odpt:RailDirection | 方面 |
レスポンス
| odpt:StationTimetable プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| @context | URL | ◯ | JSON-LD仕様に基づく @context のURL |
| @id | URN | ◯ | 固有識別子(ucode) |
| @type | odpt:StationTimetable | ◯ | クラス指定 |
| owl:sameAs | URL | ◯ | 固有識別子。命名ルールは、odpt.StationTimetable:会社名.路線名.駅名.方面名 である。 |
| dc:date | xsd:dateTime | ◯ | データ生成時刻、e.g. 2013-01-13T15:10:00+09:00、ISO8601日付時刻形式 |
| odpt:station | odpt:Station | ◯ | 駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 |
| odpt:stationTitle | xsd:string | 駅名称 | |
| odpt:railway | odpt:Railway | ◯ | 路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 |
| odpt:railwayTitle | xsd:string | 路線名称 | |
| odpt:operator | odpt:Operator | ◯ | 運行会社を表すID。 |
| odpt:operatorTitle | xsd:string | 運行会社を表すID。 | |
| odpt:railDirection | odpt:RailDirection | ◯ | 方面を表すID。 |
| odpt:railDirectionTitle | xsd:string | 方面名称 | |
| odpt:calendar | odpt:Calendar | ◯ | 運行を行う曜日・日付情報 |
| odpt:stationTimetableObject | Array(odpt:StationTimetableObject) | 平日（出発時間、行き先駅名等の組のリストを格納） |
| odpt:StationTimetableObject::プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| odpt:departureTime | odpt:Time | ◯ | 出発時間 (ISO8601時刻形式, e.g. 05:09) |
| odpt:arrivalTime | odpt:Time | 到着時間 (ISO8601時刻形式, e.g. 05:09) | |
| odpt:destinationStation | odpt:Station | ◯ | 行き先駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 |
| odpt:trainType | odpt:TrainType | ◯ | 列車種別。普通(odpt.TrainType:Local)、急行(odpt.TrainType:Express)、快速(odpt.TrainType:Rapid)、特急(odpt.TrainType:LimitedExpress)など。 |
| odpt:trainName | xsd:string | 編成の名称・愛称 | |
| odpt:train | odpt:Train | 到着する列車ID（odpt:Train） | |
| odpt:isLast | xsd:boolean | 最終電車の場合、true。最終電車でない場合は省略。 | |
| odpt:isOrigin | xsd:boolean | 始発駅の場合、true。始発駅ではない場合は省略。 | |
| odpt:carComposition | xsd:integer | 車両数（駅に停車する車両数が列車毎に異なる場合に格納する）。 | |
| odpt:note | xsd:string | その他の注釈（接続、通過待ちなど）。 |
列車運行情報 odpt:TrainInformation
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:TrainInformation&odpt:railway=odpt.Railway:SapporoCitySubway.Tozai'
[
{
"@context": "https://vocab.sapporo.odcity.org/context_odpt_TrainInformation.jsonld",
"@id": "urn:ucode:_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"dc:date": "2015-10-29T17:50:02+09:00",
"dct:valid": "2015-10-29T18:20:02+09:00",
"odpt:operator": "odpt.Operator:SapporoCitySubway",
"odpt:railway": "odpt.Railway:SapporoCitySubway.Tozai",
"odpt:timeOfOrigin": "2015-10-29T17:30:00+09:00",
"odpt:trainInformationStatus": "遅延"
"odpt:trainInformationText": "東西線は、遅れが発生しています。",
"@type": "odpt:TrainInformation"
}
]
列車運行情報を示す。基本的に発生時刻、発生箇所、現在状況を示す。平常運転時でも「平常」などの文字列を含んだ文字列を返す。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 説明 | 必須 |
|---|---|---|---|
| rdf:type | odpt:TrainInformation | クラス指定 | ◯ |
| @id | URN | 固有識別子(ucode) | |
| odpt:operator | odpt:Operator | 運行会社を表すID。 | |
| odpt:railway | odpt:Railway | 発生路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 | |
| odpt:trainInformationStatus | xsd:string | 平常時は省略。運行情報が存在する場合は「運行情報あり」を格納。遅延などの情報を取得可能な場合は、「遅延」等のテキストを格納。 |
レスポンス
| odpt:TrainInformation プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| @context | URL | ◯ | JSON-LD仕様に基づく @context のURL |
| @id | URN | ◯ | 固有識別子(ucode) |
| @type | odpt:TrainInformation | ◯ | クラス指定 |
| dc:date | xsd:dateTime | ◯ | データ生成時刻、e.g. 2013-01-13T15:10:00+09:00、ISO8601 日付時刻形式 |
| dct:valid | xsd:dateTime | ◯ | 有効期限（ISO8601 日付時刻形式） |
| odpt:operator | odpt:Operator | ◯ | 運行会社を表すID。 |
| odpt:timeOfOrigin | xsd:dateTime | ◯ | 発生時刻（ISO8601 日付時刻形式） |
| odpt:railway | odpt:Railway | ◯ | 発生路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 |
| odpt:trainInformationStatus | xsd:string | 平常時は省略。運行情報が存在する場合は「運行情報あり」を格納。遅延などの情報を取得可能な場合は、「遅延」等のテキストを格納。 | |
| odpt:trainInformationText | xsd:string | ◯ | 運行情報テキスト |
| odpt:trainInformationArea | xsd:string | 発生エリア。取得不可能な場合は省略 | |
| odpt:trainInformationKind | xsd:string | 鉄道種類。取得不可能な場合は省略 | |
| odpt:stationFrom | odpt:Station | 発生場所終点。発生場所起点。取得不可能な場合は省略 | |
| odpt:stationTo | odpt:Station | 発生場所終点。取得不可能な場合は省略 | |
| odpt:trainInformationRange | xsd:string | 発生区間。取得不可能な場合は省略 | |
| odpt:trainInformationLine | xsd:string | 列車の運転方向。取得不可能な場合は省略 | |
| odpt:trainInformationCause | xsd:string | 発生理由。取得不可能な場合は省略 |
列車ロケーション情報 odpt:Train
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:Train&odpt:railway=odpt.operationRailway:SapporoCityTram.Tram'
[
{
"@context": "https://vocab.sapporo.odcity.org/context_odpt_Train.jsonld",
"@type": "odpt:Train",
"@id": "urn:ucode:_00001C000000000000010000030C4D61",
"dc:date": "2015-10-29T20:53:51+09:00",
"dct:valid": "2015-10-29T20:54:51+09:00",
"odpt:frequency": 60,
"odpt:railway": "odpt.operationRailway:SapporoCityTram.Tram",
"owl:sameAs": "odpt.Train:SapporoCityTram.Tram.01",
"odpt:trainNumber": "01",
"odpt:trainType": "odpt.TrainType:SapporoCityTram.Local",
"odpt:startingStation": null,
"odpt:terminalStation": null,
"odpt:fromStation": "odpt.Station:SapporoCityTram.Tram.NishiYonChome",
"odpt:toStation": odpt.Station:SapporoCityTram.Tram.NishiHatchome,
"odpt:railDirection": "odpt.RailwayDirection:Outbound",
"odpt:trainOwner": "odpt.TrainOwner:SapporoCityTram"
}
]
列車の在線位置を表す。列車ロケーション情報は、「駅から駅へ移動」というodpt:fromStation, odpt:toStation, odpt:progressを用いた相対位置情報表記、geo:lat（緯度）, geo:long（経度）による絶対位置情報表記に対応する。
現在、札幌市電のみ情報の提供を行っている。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 必須 | 説明 |
|---|---|---|---|
| rdf:type | odpt:Train | ◯ | クラス指定 |
| @id | URN | 固有識別子(ucode) | |
| owl:sameAs | URL | 固有識別子。命名ルールは、odpt.Train:会社名.路線名.列車番号である。 | |
| odpt:trainNumber | xsd:string | 列車番号 | |
| odpt:trainType | odpt:TrainType | 列車種別を表すID。普通(odpt.TrainType:Local)、急行(odpt.TrainType:Express)、快速(odpt.TrainType:Rapid)、特急(odpt.TrainType:LimitedExpress)など。 | |
| odpt:railway | odpt:Railway | ◯ | 鉄道路線を表すID。IDにはodpt:Railwayのowl:sameAsを利用する。 |
| odpt:trainOwner | odpt:TrainOwner | 車両の所属会社を表すID。 | |
| odpt:railDirection | odpt:RailDirection | 方面を表すID。東京メトロ渋谷方面行きodpt.RailDirection:TokyoMetro.Shibuyaなど。 | |
| odpt:delay | xsd:integer | 遅延時間（秒） | |
| odpt:startingStation | odpt:Station | 列車の始発駅を表すID。IDにはodpt:Stationのowl:sameAsを利用する。 | |
| odpt:terminalStation | odpt:Station | 列車の終着駅を表すID。IDにはodpt:Stationのowl:sameAsを利用する。 | |
| odpt:fromStation | odpt:Station | 列車が出発した駅を表すID。IDにはodpt:Stationのowl:sameAsを利用する。 | |
| odpt:toStation | odpt:Station | 列車が向かっている駅を表すID。IDにはodpt:Stationのowl:sameAsを利用する。 |
レスポンス
| odpt:Train プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| @context | URL | ◯ | JSON-LD仕様に基づく @context のURL |
| @id | URN | ◯ | 固有識別子(ucode) |
| @type | odpt:Train | ◯ | クラス指定 |
| owl:sameAs | URL | ◯ | 固有識別子。命名ルールは、odpt.Train:会社名.路線名.列車番号である。 |
| odpt:trainNumber | xsd:string | ◯ | 列車番号 |
| odpt:trainType | odpt:TrainType | ◯ | 列車種別。普通(odpt.TrainType:Local)、急行(odpt.TrainType:Express)、快速(odpt.TrainType:Rapid)、特急(odpt.TrainType:LimitedExpress)など。 |
| odpt:trainTimetable | odpt:TrainTimetable | 列車時刻表を表すIDを格納する。IDには、odpt:TrainTimetableのowl:sameAsの値を利用する。 | |
| dc:date | xsd:dateTime | ◯ | データ生成時刻、e.g. 2013–01–13T15:10:00+09:00、ISO8601 日付時刻形式 |
| dct:valid | xsd:dateTime | ◯ | データ保証期限、e.g. 2013–01–13T15:10:00+09:00、ISO8601 日付時刻形式 |
| odpt:frequency | xsd:integer | ◯ | 更新頻度（秒）、指定された秒数以降にリクエストを行うことで、最新値が取得される |
| odpt:railway | odpt:Railway | ◯ | 鉄道路線を表すID。IDには、odpt:Railwayのowl:sameAsの値を利用する。 |
| odpt:trainOwner | odpt:TrainOwner | 車両の所属会社を表すID。 | |
| odpt:railDirection | odpt:RailDirection | ◯ | 方面を表すID。東京メトロ渋谷方面行きを表すodpt.RailDirection:TokyoMetro.Shibuyaなど。 |
| odpt:delay | xsd:integer | ◯ | 遅延時間（秒） |
| odpt:operationStatus | odpt:OperationStatus | ◯ | 列車の運行状態(odpt.OperationStatus:Yokushi, odpt.OperationStatus:OutOfService, odpt.OperationStatus:Delay, odpt.OperationStatus:ReadyForService, odpt.OperationStatus:Normal) |
| odpt:startingStation | odpt:Station | 列車の始発駅を表すIDを格納 | |
| odpt:terminalStation | odpt:Station | 列車の終着駅を表すIDを格納 | |
| odpt:fromStation | odpt:Station | ◯ | 列車が出発した駅を表すIDを格納 |
| odpt:toStation | odpt:Station | 列車が向かっている駅を表すIDを格納 | |
| odpt:progress | xsd:double | Fromを0、toを1とした際の現在位置（割合） | |
| geo:lat | xsd:double | 対象の緯度 | |
| geo:long | xsd:double | 対象の経度 |
駅情報 odpt:Station
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:Station&dc:title=宮の沢'
[
{
"@id": "urn:ucode:_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"@type": "odpt.Station",
"owl:sameAs": "odpt.Station:SapporoCitySubway.Tozai.Miyanosawa",
"dc:date": "2015-10-29T11:39:51+09:00",
"dc:title": "宮の沢",
"ug:region": "https://api-sapporo.odcity.org/api/v1/places/urn:ucode:_XXXXXXXXXXXXXXXXXXXXXXXXXXXX.geojson",
"odpt:operator": "odpt.Operator:SapporoCitySubway",
"odpt:railway": "odpt.Railway:SapporoCitySubway.Tozai",
"odpt:stationTimetable": [
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Outbound.Weekday",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Outbound.Saturday.1_3_5",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Outbound.Saturday.2_4",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Outbound.Holiday",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Inbound.Weekday",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Inbound.Saturday.1_3_5",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Inbound.Saturday.2_4",
"odpt.StationTimetable:SapporoCitySubway.Tozai.Miyanosawa.Inbound.Holiday"
],
"odpt:passengerSurvey": [
"odpt.PassengerSurvey:SapporoSubway.Miyanosawa.2014"
],
"odpt:stationCode": "T01",
"@context": "https://vocab.sapporo.odcity.orgcontext_odpt_Station.jsonld"
}
]
駅情報 odpt:Stationは、駅の情報を示す。
エンドポイント
- データ取得・検索API
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 必須 | 説明 |
|---|---|---|---|
| rdf:type | odpt:Station | ◯ | 地物のクラス名、odpt:Station |
| @id | URN | 固有識別子(ucode) | |
| owl:sameAs | URL | 固有識別子。命名ルールは、odpt.Station:会社名.路線名.駅名である。 | |
| dc:title | xsd:string | 駅名 | |
| odpt:operator | odpt:Operator | 運行会社を表すID。 | |
| odpt:railway | odpt:Railway | 路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 | |
| odpt:stationCode | xsd:string | 駅コード |
レスポンス
| odpt:Station プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| @context | URL | ◯ | JSON-LD 仕様に基づく@context のURL |
| @id | URN | ◯ | 固有識別子(ucode) |
| @type | odpt:Station | ◯ | 地物のクラス名、odpt:Station |
| owl:sameAs | URL | ◯ | 固有識別子。命名ルールは、odpt.Station:会社名.路線名.駅名である。 |
| dc:title | xsd:string | ◯ | 駅名 |
| dc:date | xsd:dateTime | ◯ | 駅情報の生成時刻(ISO8601 日付時刻形式) |
| geo:long | xsd:double | 代表点の経度、10進表記 | |
| geo:lat | xsd:double | 代表点の緯度、10進表記 | |
| ug:region | odpt:GeoDocument | ◯ | 駅地物情報取得用URL |
| odpt:operator | odpt:Operator | ◯ | 運行会社を表すID。 |
| odpt:railway | odpt:Railway | ◯ | 路線を表すIDを格納する。IDにはodpt:Railwayのowl:sameAsの値を利用する。 |
| odpt:stationTimetable | Array(odpt:StationTimetable) | ◯ | 駅時刻表を表すIDを格納する。IDにはodpt:StationTimetableのowl:sameAsの値を利用する。 |
| odpt:connectingRailway | Array(odpt:Railway) | 乗り換え可能路線のIDを格納する。IDにはodpt:Railwayのowl:sameAsの値を利用する。 | |
| odpt:source | Array(mlit:Station) | 元となったmlit:StationのIDの配列。IDにはmlit:Stationの@idの値を利用する。 | |
| odpt:facility | Array(odpt:StationFacility) | ◯ | 駅施設を表すIDのリスト。IDにはodpt:StationFacilityのowl:sameAsの値を利用する。 |
| odpt:passengerSurvey | Array(odpt:PassengerSurvey) | ◯ | 駅乗降人員数を表すIDのリスト。IDにはodpt:PassengerSurveyのowl:sameAsの値を利用する。 |
| odpt:stationCode | xsd:string | 駅コード | |
| odpt:exit | Array(odpt:Exit) | ◯ | 駅出入口を表すIDのリスト。IDにはug:Poiの@idの値を利用する。 |
補足
- ここでのug:regionが指し示すものは、geojson取得用のURLとなる
- 取得されるgeojsonは、駅構内に入線する路線のMultiLine Stringとなる
駅乗降人員数 odpt:PassengerSurvey
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:PassengerSurvey&owl:sameAs=odpt.RailwayFare:SapporoCitySubway.Namboku.KitaSanjuyoJo.SapporoCitySubway.Namboku.Asabu'
[
{
"@id": "urn:ucode:_x",
"@type": "odpt:RailwayFare",
"owl:sameAs": "odpt.RailwayFare:SapporoCitySubway.Namboku.KitaSanjuyoJo.SapporoCitySubway.Namboku.Asabu",
"dc:date": "2015-11-09T18:38:00+09:00",
"odpt:operator": "odpt.Operator:SapporoCitySubway",
"odpt:fromStation": "odpt.Station:SapporoCitySubway.Namboku.KitaSanjuyoJo",
"odpt:toStation": "odpt.Station:SapporoCitySubway.Namboku.Asabu",
"odpt:ticketFare": 200,
"odpt:childTicketFare": 100,
"odpt:icCardFare": 200,
"odpt:childIcCardFare": 100,
"@context": "https://vocab.sapporo.odcity.org/context_odpt_RailwayFare.jsonld"
}
]
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 必須 | 説明 |
|---|---|---|---|
| rdf:type | odpt:PassengerSurvey | ◯ | クラス名、odpt:PassengerSurvey |
| @id | URN | 固有識別子(ucode) | |
| owl:sameAs | URL | 固有識別子。 命名ルールはodpt.PassengerSurvey:会社名.駅名.調査年 である。e.g. odpt:PassengerSurvey:TokyoMetro.Tokyo.2013 | |
| odpt:operator | odpt:Operator | 運行会社を表すID。 | |
| odpt:station | odpt:Station | 駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:railway | odpt:Railway | 路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 | |
| odpt:surveyYear | xsd:integer | 調査年度 |
レスポンス
| odpt:PassengerSurvey プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| @context | URL | ◯ | JSON-LD仕様に基づく @context のURL |
| @id | URN | ◯ | 固有識別子(ucode) |
| @type | odpt:PassengerSurvey | ◯ | クラス名、odpt:PassengerSurvey |
| owl:sameAs | URL | ◯ | 固有識別子。 命名ルールは odpt.PassengerSurvey:会社名.駅名.調査年 である。e.g. odpt:PassengerSurvey:TokyoMetro.Tokyo.2013 |
| dc:date | xsd:dateTime | ◯ | 駅情報の生成時刻(ISO8601 日付時刻形式) |
| odpt:operator | odpt:Operator | ◯ | 運行会社を表すID。 |
| odpt:stations | Array(odpt:Station) | ◯ | 駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 |
| odpt:railways | Array(odpt:Railway) | ◯ | 路線を表すID。IDにはodpt:Railwayのowl:sameAsの値を利用する。 |
| odpt:surveyYear | xsd:integer | ◯ | 調査年度 |
| odpt:passengerJourneys | xsd:integer | ◯ | 駅の1日あたりの平均乗降人員数 |
鉄道路線情報 odpt:Railway
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:Railway&owl:sameAs=odpt.Railway:SapporoCitySubway.Tozai'
[
{
"@context": "https://vocab.sapporo.odcity.org/context_odpt_Railway.jsonld",
"@id": "urn:ucode:_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"@type": "odpt:Railway",
"ug:region": "https://api-sapporo.odcity.org/api/v1/places/urn:ucode:_XXXXXXXXXXXXXXXXXXXXXXXXXXXX.geojson",
"owl:sameAs": "odpt.Railway:SapporoCitySubway.Tozai",
"odpt:operator": "odpt.Operator:SapporoCitySubway",
"dc:title": "東西線",
"dc:date": "2015-10-29T11:39:51+09:00",
"odpt:stationOrder": [
{
"odpt:station": "odpt.Station:SapporoCitySubway.Tozai.Miyanosawa",
"odpt:index": 0
},
{
"odpt:station": "odpt.Station:SapporoCitySubway.Tozai.HassamuMinami",
"odpt:index": 1
},
{
"odpt:station": "odpt.Station:SapporoCitySubway.Tozai.Kotoni",
"odpt:index": 2
}
],
"odpt:lineCode": "T"
}
]
路線情報 odpt:Railwayは、鉄道路線の情報を示す。運行系統名、駅間所要時間、駅間順序などを加筆・修正したものとなる。
エンドポイント
- データ取得・検索API
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ（データ検索API利用時）
| パラメータ | 値域 | 必須 | 説明 |
|---|---|---|---|
| rdf:type | odpt:Railway | ◯ | 地物のクラス名、odpt:Railway |
| @id | URN | 固有識別子(ucode)。支線には別IDを割り当てる | |
| owl:sameAs | URL | 固有識別子。命名ルールは、odpt.Railway:会社名.路線名である。 | |
| dc:title | xsd:string | 運行系統名 | |
| odpt:operator | odpt:Operator | 運行会社 | |
| odpt:lineCode | xsd:string | 路線コード |
レスポンス
| 第1階層 | 第2階層 | 値域 | 必須 | 説明 |
|---|---|---|---|---|
| @context | URL | ◯ | JSON-LD仕様に基づく @context のURL | |
| @id | URN | ◯ | 固有識別子(ucode)。支線には別IDを割り当てる | |
| @type | odpt:Railway | ◯ | 地物のクラス名、odpt:Railway | |
| owl:sameAs | URL | ◯ | 固有識別子。命名ルールは、odpt.Railway:会社名.路線名である。 | |
| dc:title | xsd:string | ◯ | 運行系統名 | |
| dc:date | xsd:dateTime | ◯ | 駅情報の生成時刻(ISO8601 日付時刻形式) | |
| ug:region | odpt:GeoDocument | ◯ | 地物情報へのURL | |
| odpt:operator | odpt:Operator | ◯ | 運行会社を表すID。 | |
| odpt:color | xsd:string | 路線のラインカラーをHEXで表記する（e.g. #FF00FF） | ||
| odpt:logo | URL | 路線のロゴ画像のURLを表記する | ||
| odpt:symbol | xsd:string | 路線のシンボル表記 路線の場合は駅ナンバリングに使われている路線記号 e.g. つくばエクスプレス=>TX | ||
| odpt:color | xsd:string | 路線のラインカラーをHEXで表記する（e.g. #FF00FF） | ||
| odpt:logo | URL | 路線のロゴ画像のURLを表記する | ||
| odpt:symbol | xsd:string | 路線のシンボル表記 路線の場合は駅ナンバリングに使われている路線記号 e.g. つくばエクスプレス=>TX | ||
| odpt:lineCode | xsd:string | 路線コード、路線シンボル表記を格納 e.g. つくばエクスプレス=>TX | ||
| odpt:stationOrder | Array | ◯ | 駅の順序 | |
| odpt:station | odpt:Station | ◯ | 駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:index | xsd:integer | ◯ | 駅の番号 1オリジン、又は駅ナンバリングに従う | |
| odpt:travelTime | Array | ◯ | 駅間の標準所要時間リスト | |
| odpt:fromStation | odpt:Station | ◯ | 駅間の起点となる駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:toStation | odpt:Station | ◯ | 駅間の終点となる駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:time | xsd:integer | ◯ | 駅間の所要時間（分） | |
| odpt:trainType | odpt:TrainType | ◯ | 列車種別を表すID。 | |
| odpt:lineCode | xsd:string | 路線コードを格納 | ||
| odpt:womenOnlyCar | Array(odpt:WomenOnlyCar) | 女性専用車両情報のリスト | ||
| odpt:fromStation | odpt:Station | 女性専用車両開始駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | ||
| odpt:toStation | odpt:Station | 女性専用車両終了駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | ||
| odpt:availableTimeFrom | odpt:Time | 女性専用車両開始時間 | ||
| odpt:availableTimeUntil | odpt:Time | 女性専用車両終了時間 | ||
| odpt:operationDay | odpt:Day | 女性専用車両の実施日を表すID。odpt.Day:Weekday(平日)など。省略時は毎日実施する。 | ||
| odpt:carComposition | xsd:integer | 車両編成数 | ||
| odpt:carNumber | Array(xsd:integer) | 女性専用車両実施車両号車番号 |
補足
- 運行系統名 dc:title は、一般的に用いられる路線名・愛称を示す
運賃 odpt:RailwayFare
curl -X GET 'https://api-sapporo.odcity.org/api/v1/datapoints?rdf:type=odpt:RailwayFare&odpt:fromStation=odpt.Station:SapporoCitySubway.Tozai.Miyanosawa&odpt:toStation=odpt.Station:SapporoCitySubway.Tozai.HassamuMinami'
[
{
"@id": "urn:ucode:_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"@type": "odpt:RailwayFare",
"owl:sameAs": "odpt.RailwayFare:SapporoCitySubway.Tozai.Miyanosawa.Tozai.HassamuMinami",
"dc:date": "2015-10-29T11:39:51+09:00",
"odpt:operator": "odpt.Operator:SapporoCitySubway",
"odpt:fromStation": "odpt.Station:SapporoCitySubway.Tozai.Miyanosawa",
"odpt:toStation": "odpt.Station:SapporoCitySubway.Tozai.HassamuMinami",
"odpt:ticketFare": 200,
"odpt:childTicketFare": 100,
"odpt:icCardFare": 200,
"odpt:childIcCardFare": 100,
"@context": "https://vocab.sapporo.odcity.org/context_odpt_RailwayFare.jsonld"
}
]
2駅間の運賃を表す。各鉄道事業者が提供している時刻表を元に生成している。
エンドポイント
https://api-sapporo.odcity.org/api/v1/datapoints
パラメータ
| パラメータ | 値域 | 必須 | 説明 |
|---|---|---|---|
| rdf:type | odpt:RailwayFare | ◯ | 運賃を表すクラスであるodpt:RailwayFare |
| @id | URN | 固有識別子(ucode) | |
| owl:sameAs | URL | 固有識別子。命名ルールはodpt.RailwayFare:会社名.出発駅の路線名.出発駅名.会社名.到着駅の路線名.到着駅名である。 | |
| odpt:operator | odpt:Operator | 運行会社を表すID。 | |
| odpt:fromStation | odpt:Station | 駅間の始点駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:toStation | odpt:Station | 駅間の終点駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 | |
| odpt:ticketFare | xsd:integer | 切符利用時の運賃 | |
| odpt:childTicketFare | xsd:string | 切符利用時の子供運賃 | |
| odpt:icCardFare | xsd:integer | ICカード利用時の運賃 | |
| odpt:childIcCardFare | xsd:nteger | ICカード利用時の子供運賃 |
レスポンス
| odpt:RailwayFare プロパティ | 値域 | 必須 | 説明 |
|---|---|---|---|
| @context | URL | ◯ | JSON-LD仕様に基づく @context のURL |
| @id | URN | ◯ | 固有識別子(ucode) |
| @type | odpt:RailwayFare | ◯ | 運賃を表すクラスのodpt:RailwayFare |
| owl:sameAs | URL | ◯ | 固有識別子。命名ルールはodpt.RailwayFare:出発駅の会社名.出発駅の路線名.出発駅名.到着駅の会社名.到着駅の路線名.到着駅名である。 |
| dc:date | xsd:dateTime | ◯ | データ生成日時（ISO8601 日付時刻形式） |
| odpt:operator | odpt:Operator | ◯ | 運行会社を表すID。 |
| odpt:fromStation | odpt:Station | ◯ | 駅間の始点駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 |
| odpt:toStation | odpt:Station | ◯ | 駅間の終点駅を表すID。IDにはodpt:Stationのowl:sameAsの値を利用する。 |
| odpt:ticketFare | xsd:integer | ◯ | 切符利用時の運賃 |
| odpt:childTicketFare | xsd:string | ◯ | 切符利用時の子供運賃 |
| odpt:icCardFare | xsd:integer | ◯ | ICカード利用時の運賃 |
| odpt:childIcCardFare | xsd:integer | ◯ | ICカード利用時の子供運賃 |