Search condition generator

Based on the request parameter, route search generates condition to be used in this. If there is no detail set, it will generate search condition based on the default condition. If detail is set, it will replace the value of the specified parameter with the value of the detail. In other words, you can obtain a partially-modified version of the previously-created search data's detail conditions.

GET /v1/{format}/toolbox/course/condition

parameters

Name Type Description
format string Specifying the data format of responses. Mandatory.
Available Values:
- xml: xml format data
- json: json format data
key string access key Required
detail string Data of detailed search terms. Optional.
Default: T3221233232319:F3321122120:A23121141:
plane string Plane. Optional.
Available Values:
- light:Preferable. When ※search type is other than plain, it will show the same behavior as when specifying normal.
- normal:Normal
- bit:Avoid. When ※search type is other than plain, it will show the same behavior as when specifying never.
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
shinkansen string Bullet train. Optional.
Available Values:
- normal:Use
- never:Do not use
Default: normal (When detail parameter is specified, it is the value of the detail)
shinkansenNozomi string Bullet train. Optional.
Available Values:
- normal:Use
- never:Do not use
Defailt:normal (When detail parameter is specified, it is the value of the detail)
sleeperTrain string Sleeper train. Optional.
Available Values:
- possible:Preferable. When ※search type is other than plain, it will show the same behavior as when speficying normal.
- normal:Normal
- never:Never
Defailt:never (When detail parameter is specified, it is the value of the detail)
limitedExpress string Charged limited express train. Optional.
Available Values:
- normal:Use
- never:Do not use
Default: normal (When detail parameter is specified, it is the value of the detail)
highwayBus string Express bus. Optional.
Available Values:
- light:Preferable
- normal:Normal
- bit:Avoid. When ※search type is other than plain, it will show the same behavior as when specifying never.
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
connectionBus string Bus connection. Optional.
Available values:
- light:Preferable When ※search type is other than plain, it will show the same behavior as when specifying normal.
- normal:Normal
- bit:Avoid. When ※search type is other than plain, it will show the same behavior as when specifying never.
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
localBus string Fixed route bus. Optional.
Available Values:
- normal:Use
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
midnightBus string Express night bus. When search type is plain, it is invalid. Optional.
Available Values:
- normal:Use
- never:Never
Default: never (When detail parameter is specified, it is the value of the detail)
ship string Ship. Optional.
Avaliable Values:
- light:Preferable When ※search type is other than plain, it will show the same behavior as when specifying normal.
- normal:Normal
- bit:Avoid When ※search type is other than plain, it will show the same behavior as when specifying never.
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
liner string Charged local train. When search type is plain, it is invalid. Optional.
Available Values:
- normal:Use
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
walk string Walk between stations. Only valid when search type is plain. Optional.
Available Values:
- normal:Do not mind
- little:Avoid
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
useJR string JR route. Only valid when search type is plain. Optional.
Available Values:
- light:Preferable
- normal:Normal
- bit:Avoid
Default: normal (When detail parameter is specified, it is the value of the detail)
transfer string Change. Only valid when search type is plain. Optional.
Available Values:
- normal:Do not mind
- little:Avoid
- never:Never
Default: normal (When detail parameter is specified, it is the value of the detail)
waitAverageTime string Use of average waiting time at the departure station. Only valid when search type is plain. Optional.
Available Values:
- true:Use Average Waiting Time
- false:No Average Waiting Time
Default: true (When detail parameter is specified, it is the value of the detail)
expressStartingStation string Limited express train first departure station. Only valid when search type is plain. Optional.
Available Values:
- possible:Preferable
- normal:Normal
Default: normal (When detail parameter is specified, it is the value of the detail)
localBusOnly string Search only fixed route buses. Only valid when search type is plain. Optional.
Available Values:
- true:Enable
- false:Disable
Default: false (When detail parameter is specified, it is the value of the detail)
transferTime string Transit time. When search type is plain, it is not valid. Optional.
Available Values:
- normal:Ekispert standard time
- moreMargin:Allow slightly more time than the standard
- mostMargin:Allow more time than the standard
- lessMargin:Reduce more time than the standard
Default: normal (When detail parameter is specified, it is the value of the detail)
fuzzyLine string average rail Specify undefined name. Only valid when search type is plain. Optional.
Available Values:
- true:Enable without definition
- false:Enable with definition
Default: false (When detail parameter is specified, it is the value of the detail)
entryPathBehavior string Maintain stopover station when editing the route. Optional.
Available Values:
- true:Enable
- false:Disable
Default: false (When detail parameter is specified, it is the value of the detail)
For detailed information, please follow this link.
surchargeKind string Requested Initial Value according to Limited Express Train Price Range. Optional.
Available Values:
- free:Unreserved
- reserved:Reserved
- green:Green
Default: free (When detail parameter is specified, it is the value of the detail)
teikiKind string Initial value according to commutation ticket type. Optional.
Available Value:
- bussiness:Business
- highSchool:Student Discount (High School)
- university:Student Discount (University)
Default: bussiness (When detail parameter is specified, it is the value of the detail)
JRSeasonalRate string JR Seasonal Price. Optional.
Available Values:
- true:Consider the seasonal price for peak season and off season
- false:Ignore
Default: true (When detail parameter is specified, it is the value of the detail)
studentDiscount string Student Discount Ticket. Optional.
Available Values:
- true:Calculate
- false:Do Not Calculate
Default: false (When detail parameter is specified, it is the value of the detail)
airFare string Specify airfare. Optional.
Available Values:
- normal:Always choose normal fare
- tokuwari:Adopt special flight discount (Tokuwari) whenever possible
Default: tokuwari (When detail parameter is specified, it is the value of the detail)
includeInsurance string Flight insurance special price. Optional.
Available Values:
- true:Include in the fare
- false:Do not include in the fare
Default: true (When detail parameter is specified, it is the value of the detail)
ticketSystemType string Ticket calculation system. Optional.
Available Values:
- normal:Only calculate normal ticket
- ic:Also calculate IC card ticket
Default: normal (When detail parameter is specified, it is the value of the detail)
preferredTicketOrder string The priority order of ticket. Only valid when setting "ic" in the ticket calculation system. Optional.
Available Values:
- none:Do not specify
- normal:Prioritize normal ticket
- ic:Prioritize IC card ticket
- cheap:Prioritize cheap ticket
Default: none (When detail parameter is specified, it is the value of the detail)
nikukanteiki string Use of two-zone commuter pass Optional.
Available Values:
- true:Use
- false:Do not use
Default: false (When detail parameter is specified, it is the value of the detail)

entryPathBehavior

When editing routes, you use it if you want to maintain the specification of stopover station. If you edit the route (such as "allocate the next timetable") by using route reproduction or cummuter pass / train assginment there is a possibility that optimization of the route may delete the redundant section of the route which includes the stopover station. By specifying entryPathBehavior=true in the detailed search option while searching, you can achieve a search result that maintains the specification of stopover station when editing the route.

response

Name Description
ResultSet Element representing lowest response
ResultSet / apiVersion Web API version
ResultSet / engineVersion Engine version
ResultSet / Condition Element representing detailed search terms

example

GET /v1/xml/toolbox/course/condition?key=your_access_key_here&plane=normal&walk=little
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Condition>T3221233232219:F3321122120:A23121141:</Condition>
</ResultSet>
GET /v1/json/toolbox/course/condition?key=your_access_key_here&plane=normal&walk=little
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Condition": "T3221233232219:F3321122120:A23121141:"
  }
}