API docs by Redocly

観光情報API (0.5.4)

Download OpenAPI specification:Download

E-mail: kenta@diverta.co.jp

下記、概念図になります。

備考

※必須項目（Required）が、データの関係上、空欄となっている場合があります。

変更履歴

  • 0.5.4
    • slugのexample値を追加
    • 備考欄を追加
  • 0.5.3
    • imageが空になる条件を追記
  • 0.5.2
    • price.priceをintergerからstringに修正
    • orderWeight項目の追加
  • 0.5.1
    • 必須項目の記載を修正
    • filterパラメータで利用可能な項目の説明を追加
    • Web用APIの仕様を削除
  • 0.5.0
    • Owner: 削除
    • Location: 項目の追加・変更・削除
      • - owner
      • - datePosted
      • - validThrough
      • - openingDayOfWeek
      • - price.priceForChild
      • - price.paymentMethod
      • - embed
      • + priceNotes
      • + culturalProperty
      • + facilityInfomation
      • + accommodationInformation
      • + hotSpringInformation
      • + scale
      • + canceled
      • + genre
      • + j_gmap_x
      • + j_gmap_y
      • + w_gmap_x
      • + w_gmap_y
      • + topics_id
      • closed: 説明文を修正
      • embed: 説明文を修正
    • Event: 項目の追加・変更・削除
      • - datePosted
      • - latestEventCode
      • - jstsD
      • - price.priceForChild
      • - price.paymentMethod
      • - embed
      • + priceNotes
      • + visitors
      • + genre
      • + j_gmap_x
      • + j_gmap_y
      • + w_gmap_x
      • + w_gmap_y
      • + topics_id
      • embed: 説明文を修正
過去の変更履歴
  • 0.2.3 => 0.3.2 キー名変更
    • location => locationCode
    • owner => ownerCode
    • area => areaCode
    • place => location
  • 0.3.2 => 0.3.3 キー名変更
    • prefecture.code => prefecture.key
    • prefecture.name => prefecture.label
    • city.code => city.key
    • city.name => city.label
  • 0.3.3 => 0.3.4 項目追加
    • categoryTag追加
  • 0.3.4 => 0.3.6 項目追加・検索条件変更
    • priceを配列に変更
    • rankingCount追加
    • キーワード検索をtopics_keywordからsearch_keywordに変更（topics_keywordは利用できますが、条件が増える可能性も考えるとsearch_keywordを推奨）
    • Queryにtag_id[]の記述を追加(tagId[]も両方利用できるようになる予定)
  • 0.3.5
    • minAgeRequirementをageとtextのobjectに変更
  • 0.3.6
    • データ内の改行コードをCrLfに統一
  • 0.4.0
    • イベントのeventIndividualCodeをlatestEventCodeに変更
    • イベントにjurisdictionalLocalPublicEntityCodeを追加
    • 項目のの並び順などを共通のものなどで整理
    • OwnerCodeの子項目textをnameに変更
    • ExperiencePlaceにimage画像を追加
  • 0.4.1
    • 各コードのprefixは利用しないことになりました。
  • 0.4.2
    • APIエンドポイントのHOSTをapi.japan47go.travelに変更
  • 0.4.3
    • 各モデルにstartDateDisplay,endDateDisplay,regularFlgを追加
    • locationのtypeを削除
  • 0.4.4
    • Queryに_langを追加
  • 0.4.5
    • Mesh項目を削除
Find out more about Swagger

Location

topics_id
required
integer

コンテンツID

slug
required
string
locationCode
required
string

ロケーションコード UUID（Universally Unique Identifier）

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
required
string

【3モデル共通】名称かな

nameEnglish
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
required
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

culturalProperty
string

文化財

facilityInfomation
string

施設情報

accommodationInformation
string

宿泊情報

hotSpringInformation
string

温泉情報

scale
string

規模

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

genre
required
integer

カテゴリID

nameCommon
string

ロケーションの通称

poiCode
string
closed
boolean

クローズフラグ (false固定)

object (Price)
canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

営業開始時間

endTime
string

営業終了時間

openingDateNotes
string

営業日のテキスト表記

object (MinAgeRequirement)

利用最小年齢

j_gmap_y
string

日本測地系（緯度）

j_gmap_x
string

日本測地系（経度）

w_gmap_y
string

世界測地系（緯度）

w_gmap_x
string

世界測地系（経度）

{
  • "topics_id": 1,
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "locationCode": "550e8400-e29b-41d4-a716-446655440000",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "culturalProperty": "",
  • "facilityInfomation": "",
  • "accommodationInformation": "",
  • "hotSpringInformation": "",
  • "scale": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "genre": 79,
  • "nameCommon": "",
  • "poiCode": "コード",
  • "closed": false,
  • "price": {
    },
  • "canceled": true,
  • "regularFlg": true,
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "09:00",
  • "endTime": "19:00",
  • "openingDateNotes": "月〜金営業。祝日は休館になります。",
  • "minAgeRequirement": {
    },
  • "j_gmap_y": "",
  • "j_gmap_x": "",
  • "w_gmap_y": "",
  • "w_gmap_x": ""
}

ロケーションの一覧情報を取得するAPIです。

ロケーションの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

ロケーションの個別情報を取得するAPIです。

ロケーションの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of location to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Experience

slug
required
string
experienceCode
required
string

エクスペリエンスコード UUID（Universally Unique Identifier）

experienceType
string

エクスペリエンスの種別

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
string

【3モデル共通】名称かな

nameEnglish
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

object (Image)
Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

Array of objects (ExperiencePlace)

ルート情報

duration
integer <int32>

利用時間の目安時間を分単位

canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

利用開始時間

endTime
string

利用終了時間

availableDayOfWeek
Array of strings (DayOfWeek)
Items Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

利用曜日

dateSpecification
string

日時に関する特記事項

capacity
string

定員

application
string

参加申込み方法の説明

applicationStartDate
string <date-time>

参加申込み開始日時

applicationEndDate
string <date-time>

参加申込み終了日

organizer
string

主催者

placeName
string

開催地名称

object (MinAgeRequirement)

利用最小年齢

{
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "experienceCode": "550e8400-e29b-41d4-a716-446655440000",
  • "experienceType": "自然体験",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "logo": {
    },
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "route": [
    ],
  • "duration": 234,
  • "canceled": true,
  • "regularFlg": true,
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "10:00:00",
  • "endTime": "21:00:00",
  • "availableDayOfWeek": [
    ],
  • "dateSpecification": "",
  • "capacity": "",
  • "application": "",
  • "applicationStartDate": "2022-07-01T00:00:00+09:00",
  • "applicationEndDate": "2022-07-25T00:00:00+09:00",
  • "organizer": "",
  • "placeName": "",
  • "minAgeRequirement": {
    }
}

エクスペリエンスの一覧情報を取得するAPIです。

エクスペリエンスの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword,locationCode

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

エクスペリエンスの個別情報を取得するAPIです。

エクスペリエンスの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of experience to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Event

topics_id
required
integer

コンテンツID

slug
required
string
eventIndividualCode
required
string

イベント共通コード UUID（Universally Unique Identifier）

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
required
string

【3モデル共通】名称かな

nameEnglish
required
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
required
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
required
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
required
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

genre
required
integer

カテゴリID

nameCommon
string

イベントの通称

object (Price)
placeName
string

開催場所の名称

canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

validThrough
string <date-time>

情報の有効期限日時

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

開始時間

endTime
string

終了時間

dateSpecification
string

日時に関する特記事項

capacity
string

定員

visitors
string

来場者数

application
string

参加申込み方法の説明

applicationStartDate
string <date-time>

参加申込み開始日時

applicationEndDate
string <date-time>

参加申込み終了日

organizer
string

主催者

j_gmap_y
string

日本測地系（緯度）

j_gmap_x
string

日本測地系（経度）

w_gmap_y
string

世界測地系（緯度）

w_gmap_x
string

世界測地系（経度）

{
  • "topics_id": 1,
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "eventIndividualCode": "550e8400-e29b-41d4-a716-446655440000",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "genre": 22,
  • "nameCommon": "",
  • "price": {
    },
  • "placeName": "",
  • "canceled": true,
  • "regularFlg": true,
  • "validThrough": "2017-03-18T00:00:00+09:00",
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "時間",
  • "endTime": "時間",
  • "dateSpecification": "",
  • "capacity": "",
  • "visitors": "",
  • "application": "",
  • "applicationStartDate": "2022-07-01T00:00:00+09:00",
  • "applicationEndDate": "2022-07-25T00:00:00+09:00",
  • "organizer": "",
  • "j_gmap_y": "",
  • "j_gmap_x": "",
  • "w_gmap_y": "",
  • "w_gmap_x": ""
}

イベント一覧を取得します。

数日にわたって行われるイベントの場合で、イベントの開始日と終了日の両方を指定する日によって異なるイベントが複数あり、申込みなども別々になっている場合は、イベントごとに別個の データになります。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

イベントの個別情報を取得するAPIです。

イベントの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of event to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Tag

id
integer <int32>

タグのID

text
string

タグの表示名

{
  • "id": 123,
  • "text": "手ぶら"
}

Event

topics_id
required
integer

コンテンツID

slug
required
string
eventIndividualCode
required
string

イベント共通コード UUID（Universally Unique Identifier）

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
required
string

【3モデル共通】名称かな

nameEnglish
required
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
required
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
required
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
required
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

genre
required
integer

カテゴリID

nameCommon
string

イベントの通称

object (Price)
placeName
string

開催場所の名称

canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

validThrough
string <date-time>

情報の有効期限日時

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

開始時間

endTime
string

終了時間

dateSpecification
string

日時に関する特記事項

capacity
string

定員

visitors
string

来場者数

application
string

参加申込み方法の説明

applicationStartDate
string <date-time>

参加申込み開始日時

applicationEndDate
string <date-time>

参加申込み終了日

organizer
string

主催者

j_gmap_y
string

日本測地系（緯度）

j_gmap_x
string

日本測地系（経度）

w_gmap_y
string

世界測地系（緯度）

w_gmap_x
string

世界測地系（経度）

{
  • "topics_id": 1,
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "eventIndividualCode": "550e8400-e29b-41d4-a716-446655440000",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "genre": 22,
  • "nameCommon": "",
  • "price": {
    },
  • "placeName": "",
  • "canceled": true,
  • "regularFlg": true,
  • "validThrough": "2017-03-18T00:00:00+09:00",
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "時間",
  • "endTime": "時間",
  • "dateSpecification": "",
  • "capacity": "",
  • "visitors": "",
  • "application": "",
  • "applicationStartDate": "2022-07-01T00:00:00+09:00",
  • "applicationEndDate": "2022-07-25T00:00:00+09:00",
  • "organizer": "",
  • "j_gmap_y": "",
  • "j_gmap_x": "",
  • "w_gmap_y": "",
  • "w_gmap_x": ""
}

イベント一覧を取得します。

数日にわたって行われるイベントの場合で、イベントの開始日と終了日の両方を指定する日によって異なるイベントが複数あり、申込みなども別々になっている場合は、イベントごとに別個の データになります。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

イベントの個別情報を取得するAPIです。

イベントの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of event to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Location

topics_id
required
integer

コンテンツID

slug
required
string
locationCode
required
string

ロケーションコード UUID（Universally Unique Identifier）

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
required
string

【3モデル共通】名称かな

nameEnglish
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
required
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

culturalProperty
string

文化財

facilityInfomation
string

施設情報

accommodationInformation
string

宿泊情報

hotSpringInformation
string

温泉情報

scale
string

規模

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

genre
required
integer

カテゴリID

nameCommon
string

ロケーションの通称

poiCode
string
closed
boolean

クローズフラグ (false固定)

object (Price)
canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

営業開始時間

endTime
string

営業終了時間

openingDateNotes
string

営業日のテキスト表記

object (MinAgeRequirement)

利用最小年齢

j_gmap_y
string

日本測地系（緯度）

j_gmap_x
string

日本測地系（経度）

w_gmap_y
string

世界測地系（緯度）

w_gmap_x
string

世界測地系（経度）

{
  • "topics_id": 1,
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "locationCode": "550e8400-e29b-41d4-a716-446655440000",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "culturalProperty": "",
  • "facilityInfomation": "",
  • "accommodationInformation": "",
  • "hotSpringInformation": "",
  • "scale": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "genre": 79,
  • "nameCommon": "",
  • "poiCode": "コード",
  • "closed": false,
  • "price": {
    },
  • "canceled": true,
  • "regularFlg": true,
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "09:00",
  • "endTime": "19:00",
  • "openingDateNotes": "月〜金営業。祝日は休館になります。",
  • "minAgeRequirement": {
    },
  • "j_gmap_y": "",
  • "j_gmap_x": "",
  • "w_gmap_y": "",
  • "w_gmap_x": ""
}

ロケーションの一覧情報を取得するAPIです。

ロケーションの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

ロケーションの個別情報を取得するAPIです。

ロケーションの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of location to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Experience

slug
required
string
experienceCode
required
string

エクスペリエンスコード UUID（Universally Unique Identifier）

experienceType
string

エクスペリエンスの種別

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
string

【3モデル共通】名称かな

nameEnglish
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

object (Image)
Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

Array of objects (ExperiencePlace)

ルート情報

duration
integer <int32>

利用時間の目安時間を分単位

canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

利用開始時間

endTime
string

利用終了時間

availableDayOfWeek
Array of strings (DayOfWeek)
Items Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

利用曜日

dateSpecification
string

日時に関する特記事項

capacity
string

定員

application
string

参加申込み方法の説明

applicationStartDate
string <date-time>

参加申込み開始日時

applicationEndDate
string <date-time>

参加申込み終了日

organizer
string

主催者

placeName
string

開催地名称

object (MinAgeRequirement)

利用最小年齢

{
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "experienceCode": "550e8400-e29b-41d4-a716-446655440000",
  • "experienceType": "自然体験",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "logo": {
    },
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "route": [
    ],
  • "duration": 234,
  • "canceled": true,
  • "regularFlg": true,
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "10:00:00",
  • "endTime": "21:00:00",
  • "availableDayOfWeek": [
    ],
  • "dateSpecification": "",
  • "capacity": "",
  • "application": "",
  • "applicationStartDate": "2022-07-01T00:00:00+09:00",
  • "applicationEndDate": "2022-07-25T00:00:00+09:00",
  • "organizer": "",
  • "placeName": "",
  • "minAgeRequirement": {
    }
}

エクスペリエンスの一覧情報を取得するAPIです。

エクスペリエンスの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword,locationCode

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

エクスペリエンスの個別情報を取得するAPIです。

エクスペリエンスの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of experience to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Tag

id
integer <int32>

タグのID

text
string

タグの表示名

{
  • "id": 123,
  • "text": "手ぶら"
}

Contact

contactName
string

連絡先の名称

contactNotes
string

連絡先に関する情報

contactTel
string

連絡先の電話番号

contactExtensionNumber
string

連絡先の内線番号

contactEmail
string

連絡先のメールアドレス

contactFax
string

連絡先のFax

{
  • "contactName": "",
  • "contactNotes": "",
  • "contactTel": "",
  • "contactExtensionNumber": "",
  • "contactEmail": "",
  • "contactFax": ""
}

Price

price
string

料金

priceNotes
string

料金の備考

{
  • "price": "1500",
  • "priceNotes": ""
}

Location

topics_id
required
integer

コンテンツID

slug
required
string
locationCode
required
string

ロケーションコード UUID（Universally Unique Identifier）

miruNaviCode
string

【3モデル共通】観るなびで使っていたコード

name
required
string

【3モデル共通】正式名称

nameKana
required
string

【3モデル共通】名称かな

nameEnglish
string

【3モデル共通】名称英語名

jurisdictionalLocalPublicEntityCode
orderNo
required
integer <int32>

【3モデル共通】表示順

catchphrase
string

【3モデル共通】キャッチコピー

description
required
string

【3モデル共通】説明

access
string

【3モデル共通】交通アクセスに関する説明

parking
string

【3モデル共通】駐車場に関する説明

accessible
string

【3モデル共通】バリアフリー・ハラルに関する説明

multilingual
string

【3モデル共通】多言語対応に関する説明

culturalProperty
string

文化財

facilityInfomation
string

施設情報

accommodationInformation
string

宿泊情報

hotSpringInformation
string

温泉情報

scale
string

規模

sustainable
string

【3モデル共通】日本版持続可能な観光ガイドラインに関する説明

notes
string

【3モデル共通】備考

importantNotice
string

【3モデル共通】重要通知事項

startDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

endDate
string <date>

【3モデル共通】日付検索用の日付・モデルによる意味が変わる

orderWeight
integer <int32>

【3モデル共通】サイト表示管理 (並べ替えの優先度)

rankingCount
integer <int32>

【3モデル共通】ランキングに利用する数値

updateDate
required
string <date-time>

【3モデル共通】情報の最終更新日時

object (Place)
Array of objects (Contact)

【3モデル共通】問い合わせ先

Array of objects (Image)

【3モデル共通】画像

画像ファイル(url)が設定されていない場合、
他の項目(altText等)に値が入っていてもobjectを返さず、間を詰めて表示

// 全ての画像項目で画像ファイルが設定されていない場合
[]

// 1-3番目の画像項目のうち、2番目に画像ファイルが設定されていない場合
[
  { "url": "https://**", ..., "altText": "Image1", ...},
  { "url": "https://**", ..., "altText": "Image3", ...}
]
Array of objects (Tag)

【3モデル共通】タグ

object (CategoryTag)
Array of objects (AreaCode)

【3モデル共通】エリア

Array of objects (SeasonTag)

【3モデル共通】季節シーズン

Array of objects (Url)

【3モデル共通】URL

embed
Array of any

【3モデル共通】画像などのリンク (空配列固定)

genre
required
integer

カテゴリID

nameCommon
string

ロケーションの通称

poiCode
string
closed
boolean

クローズフラグ (false固定)

object (Price)
canceled
boolean

中止フラグ

regularFlg
boolean

通年実施フラグ

startDateDisplay
string

曖昧に表示するときの開始日の文字列

endDateDisplay
string

曖昧に表示するときの終了日の文字列

startTime
string

営業開始時間

endTime
string

営業終了時間

openingDateNotes
string

営業日のテキスト表記

object (MinAgeRequirement)

利用最小年齢

j_gmap_y
string

日本測地系（緯度）

j_gmap_x
string

日本測地系（経度）

w_gmap_y
string

世界測地系（緯度）

w_gmap_x
string

世界測地系（経度）

{
  • "topics_id": 1,
  • "slug": "550e8400-e29b-41d4-a716-446655440000",
  • "locationCode": "550e8400-e29b-41d4-a716-446655440000",
  • "miruNaviCode": "",
  • "name": "",
  • "nameKana": "",
  • "nameEnglish": "",
  • "jurisdictionalLocalPublicEntityCode": [
    ],
  • "orderNo": 456,
  • "catchphrase": "",
  • "description": "",
  • "access": "",
  • "parking": "",
  • "accessible": "",
  • "multilingual": "",
  • "culturalProperty": "",
  • "facilityInfomation": "",
  • "accommodationInformation": "",
  • "hotSpringInformation": "",
  • "scale": "",
  • "sustainable": "",
  • "notes": "これは備考を入力します。",
  • "importantNotice": "重要な通知があります。",
  • "startDate": "2022-12-01",
  • "endDate": "2023-12-31",
  • "orderWeight": 1,
  • "rankingCount": 12,
  • "updateDate": "2022-08-31T12:42:22+09:00",
  • "location": {
    },
  • "contact": [
    ],
  • "image": [
    ],
  • "tag": [
    ],
  • "categoryTag": "",
  • "area": [
    ],
  • "season": [
    ],
  • "url": [],
  • "embed": [ ],
  • "genre": 79,
  • "nameCommon": "",
  • "poiCode": "コード",
  • "closed": false,
  • "price": {
    },
  • "canceled": true,
  • "regularFlg": true,
  • "startDateDisplay": "3月上旬",
  • "endDateDisplay": "4月下旬",
  • "startTime": "09:00",
  • "endTime": "19:00",
  • "openingDateNotes": "月〜金営業。祝日は休館になります。",
  • "minAgeRequirement": {
    },
  • "j_gmap_y": "",
  • "j_gmap_x": "",
  • "w_gmap_y": "",
  • "w_gmap_x": ""
}

ロケーションの一覧情報を取得するAPIです。

ロケーションの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

ロケーションの個別情報を取得するAPIです。

ロケーションの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of location to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Place

object (LocationCode)
postalCode
string

郵便番号

object (PrefectureCode)

都道府県

object (CityCode)

市区町村

address
string

住所

addressDetail
string

住所の方書

latitude
string

イベント開催地の世界系の緯度

longitude
string

イベント開催地の世界系の経度

{
  • "locationCode": {
    },
  • "postalCode": "0120021",
  • "prefecture": {
    },
  • "city": {
    },
  • "address": "北海道札幌市厚別区2-○-○",
  • "addressDetail": "○○ビル1階",
  • "latitude": "",
  • "longitude": ""
}

ExperiencePlace

object (LocationCode)
object or null (ExperiencePlace_routeToNext)
object (Image)
name
string

ロケーションの名称

catchphrase
string

キャッチフレーズ(ルートで設定)

description
string

説明

type
string or null
Enum: "location" "event"

スポット種別(ルートで設定)

postalCode
string

郵便番号

object (PrefectureCode)

都道府県

object (CityCode)

市区町村

address
string

住所

addressDetail
string

住所の方書

latitude
string

世界系の緯度

longitude
string

世界系の経度

{
  • "locationCode": {
    },
  • "routeToNext": null,
  • "image": {
    },
  • "name": "string",
  • "catchphrase": "string",
  • "description": "string",
  • "type": "location",
  • "postalCode": "0120021",
  • "prefecture": {
    },
  • "city": {
    },
  • "address": "北海道札幌市厚別区2-○-○",
  • "addressDetail": "○○ビル1階",
  • "latitude": "",
  • "longitude": ""
}

AreaCode

code1
string

エリアの大カテゴリコード

text1
string

エリアの大カテゴリ名

code2
string

エリアの中カテゴリコード

text2
string

エリアの中カテゴリ名

code3
string

エリアの小カテゴリコード

text3
string

エリアの小カテゴリ名

{
  • "code1": "001",
  • "text1": "名古屋・三河湾・美濃・飛騨",
  • "code2": "00101",
  • "text2": "美濃・飛騨",
  • "code3": "0010101",
  • "text3": "飛騨"
}

Tag

id
integer <int32>

タグのID

text
string

タグの表示名

{
  • "id": 123,
  • "text": "手ぶら"
}

LocationCode

code
string

ロケーションコード

name
string

ロケーション名

{
  • "code": "21203ca3439721173",
  • "name": "美女高原キャンプ場"
}

SeasonTag

id
string

季節コード

text
string

季節コードの表示名

{
  • "id": "0001",
  • "text": "紅葉"
}

Url

linkText
string

外部リンクのリンク文字列

url
string

https://から始まる外部リンク

{}

Image

url
required
string

画像のURL

size
string

画像のサイズ（kbなどのフォーマット）

width
integer <int64>

画像の横幅（px）

height
integer <int64>

画像の縦幅（px）

mime
string

画像のMIMEタイプ

captionText
required
string

画像のキャプション

altText
required
string

画像のALTテキスト

creditText
required
string

画像のライセンス

licenseText
required
string

画像のライセンス

{
  • "url": "https://example.jp/files/topics/dummy.jpg",
  • "size": "123kb",
  • "width": 1200,
  • "height": 800,
  • "mime": "image/jpeg",
  • "captionText": "この画像はイベントのクライマックスです。",
  • "altText": "イベントのクライマックス画像",
  • "creditText": "",
  • "licenseText": ""
}

PageInfo

totalCnt
required
integer <int32>

データの総件数

perPage
required
integer <int32>

ページ毎の件数

totalPageCnt
required
integer <int32>

ページ総数

pageNo
required
integer <int32>

現在のページ番号

firstIndex
required
integer <int32>

現在のページでの最初のデータのインデックス

lastIndex
required
integer <int32>

在のページでの最後のデータのインデックス

path
required
string

ページングしているAPIエンドポイントのパス

param
required
string

ページングしているAPIエンドポイントのパラメータ

startPageNo
required
integer <int32>

前後5件毎にページングリンクを作った場合の最初のページ番号

endPageNo
required
integer <int32>

前後5件毎にページングリンクを作った場合の最後のページ番号

{
  • "totalCnt": 240,
  • "perPage": 20,
  • "totalPageCnt": 12,
  • "pageNo": 1,
  • "firstIndex": 12,
  • "lastIndex": 1,
  • "path": "/rcms-api/1/events",
  • "param": "?keyword=dummy",
  • "startPageNo": 1,
  • "endPageNo": 10
}

Location

ロケーションの一覧情報を取得するAPIです。

ロケーションの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

ロケーションの個別情報を取得するAPIです。

ロケーションの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of location to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Experience

エクスペリエンスの一覧情報を取得するAPIです。

エクスペリエンスの一覧情報を取得します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword,locationCode

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

エクスペリエンスの個別情報を取得するAPIです。

エクスペリエンスの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of experience to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Event

イベント一覧を取得します。

数日にわたって行われるイベントの場合で、イベントの開始日と終了日の両方を指定する日によって異なるイベントが複数あり、申込みなども別々になっている場合は、イベントごとに別個の データになります。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

tag_id[]
Array of strings
Example: tag_id[]=123

タグIDを指定できます

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

filter
string
Example: filter=updateDate >=:relatively "1 week" and prefecture = "01" and city = "01100" and search_keyword contains "イベント"

フィルタークエリ(文法はこちらを参照 https://kuroco.app/ja/docs/reference/filter-query/)

指定可能な項目: updateDate,prefecture,city,search_keyword

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}

イベントの個別情報を取得するAPIです。

イベントの個別情報を取得します。取得出来る情報は一覧のものと同じです。

Authorizations:
api_key
path Parameters
slug
required
string

slug of event to return

query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "details": {
    }
}

Tag

タグの一覧を取得します。

タグの全件を表示します。

Authorizations:
api_key
query Parameters
_lang
string
Example: _lang=en

レスポンスする言語コード（指定しないとRequest headerのaccept-languageを利用して、指定がないとja）

cnt
integer
Example: cnt=100

1ページの行数（指定しないと20）

pageID
integer
Example: pageID=2

ページID（指定しないと1）

topics_keyword
string
Example: topics_keyword=キーワード

キーワード検索

order_query
string
Example: order_query=order_no=ASC

並び順を設定する

Responses

Response samples

Content type
application/json
{
  • "errors": [ ],
  • "messages": [ ],
  • "list": [
    ],
  • "pageInfo": {
    }
}