Search condition generator

Returns a string representing conditions of route search which is specified at request parameters. When "detail" parameter is not specified, this API generates a condition string based on default conditions. When "detail" parameter is specified, search conditions specified at other request parameters will be applied to the corresponding "detail" conditions. This means that you can partially modify the previously-created conditions using "detail" parameter.

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

parameters

Name Type Description
format string Specifying the response data format. Required.
Possible values:
- xml: xml format data
- json: json format data.
key string Your access key. Required.
detail string String representing detailed search conditions. Optional.
Default: T3221233232319:F332112212000:A23121141:
plane string Use of plane. Optional.
Available Values:
- light: Feel free to use. ※When specified search type is not "plain", the value of this parameter will be "normal".
- normal: Use normally.
- bit: Avoid to use as much as possible. ※When specified search type is not "plain", the value of this parameter will be "never".
- never: Never use.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
shinkansen string Use of Shinkansen(Bullet train). Optional.
Available Values:
- normal: Use
- never: Never use
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
shinkansenNozomi string Use of Shinkansen Nozomi. Optional.
Available Values:
- normal: Use
- never: Never use
Defalt: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
sleeperTrain string Use of sleeper train. Optional.
Available Values:
- possible: Preferable. ※When specified search type is not "plain", it will show the same behavior as when speficying normal.
- normal: Use normally.
- never: Never use.
Defalt: never (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
limitedExpress string Use of limited express. Optional.
Available Values:
- normal: Use
- never: Never use
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
highwayBus string Use of highway bus. Optional.
Available Values:
- light: Feel free to use.
- normal: Use normally.
- bit: Avoid to use as much as possible. ※When specified search type is not "plain", it will show the same behavior as when specifying never.
- never: Never use.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
connectionBus string Use of connecting bus. Optional.
Available values:
- light: Feel free to use. ※When specified search type is not "plain", the value of this parameter will be "normal".
- normal: Use normally.
- bit: Avoid to use as much as possible. ※When specified search type is not "plain", it will show the same behavior as when specifying never.
- never: Never use.
Default: normal (When "detail" parameter is specified, it is the value of the
localBus string Use of local bus. Optional.
Available Values:
- normal: Use
- never: Never use.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
midnightBus string Use of night express bus. Invalid when search type is "plain". Optional.
Available Values:
- normal: Use
- never: Never use.
Default: never (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
ship string Use of Ship. Optional.
Available Values:
- light: Feel free to use. ※When specified search type is not "plain", the value of this parameter will be "normal".
- normal: Use normally.
- bit: Avoid to use as much as possible. ※When specified search type is not "plain", it will show the same behavior as when specifying never.
- never: Never use.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
liner string Use of fee-charging local train. Invalid when search type is "plain". Optional.
Available Values:
- normal: Use
- never: Never use.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
walk string Walking from station to station. Only valid when search type is "plain". Optional.
Available Values:
- normal: Do not mind
- little: Avoid
- never: Never use.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
useJR string Use of JR line. Only valid when search type is "plain". Optional.
Available Values:
- light: Feel free to use.
- normal: Use normally.
- bit: Avoid to use as much as possible.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
transfer string Transfer of trains. 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, this value will be the same as value specified at "detail" parameter.)
waitAverageTime string Use of average wait time at the departure station. Only valid when search type is "plain". Optional.
Available Values:
- true: Use average wait time
- false: No wait time
Default: true (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
expressStartingStation string Use of starting station of express train. Only valid when search type is "plain". Optional.
Available Values:
- possible: Preferable
- normal: Use normally.
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
localBusOnly string Search route which uses only local bus. Only valid when search type is "plain". Optional.
Available Values:
- true: Enable
- false: Disable
Default: false (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
transferTime string The time required to transfer train. When search type is plain, it is not valid. Optional.
Available Values:
- normal: standard time defined by Ekispert
- 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, this value will be the same as value specified at "detail" parameter.)
fuzzyLine string Whether allowing ambiguous specification of average rail name. Only valid when search type is "plain". Optional.
Available Values:
- true: Search ambiguously
- false: Search strictly
Default: false (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
entryPathBehavior string Keep specification of via-stations when editing the route. Optional.
Available Values:
- true: Enable
- false: Disable
Default: false (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
Please check here for more details.
surchargeKind string Specifying initial value of limited express price type. Optional.
Available Values:
- free: Non-reserved
- reserved: Reserved
- green: Green(first class)
Default: free (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
teikiKind string Specifying initial value of commuter pass type. Optional.
Available Value:
- bussiness: Commute
- highSchool: Student Discount (High School)
- university: Student Discount
Default: bussiness (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
JRSeasonalRate string Considering JR Seasonal Price. Optional.
Available Values:
- true: Consider busy season/off-season
- false: Ignore
Default: true (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
studentDiscount string Considering student discount ticket. Optional.
Available Values:
- true: Do calculate
- false: Do not calculate
Default: false (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
ticketSystemType string Specifying Ticket calculation system. Optional.
Available Values:
- normal:Only calculate normal ticket
- ic: Also calculate IC card ticket
Default: normal (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
preferredTicketOrder string Specifying preferred order of ticket. Only valid when setting "ic" at "ticketSystemType" parameter. Optional.
Available Values:
- none: Do not specify
- normal: Prioritize normal ticket
- ic: Prioritize IC card
- cheap: Prioritize cheap ticket
Default: none (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)
nikukanteiki string Use of two-zone commuter pass Optional.
Available Values:
- true: Use
- false: Never use
Default: false (When "detail" parameter is specified, this value will be the same as value specified at "detail" parameter.)

entryPathBehavior

This parameter may be used to keep specification of via-stations when editing routes. If you edit the route using route reproduction or cummuter pass / train assginment, e.g. allocating the next timetable, there is a possibility that redundant section including via-stations are deleted for the reason of route optimization. You can keep via-station at result route by using detailed search condition with "entryPathBehavior=true".

response

Name Description
ResultSet Root element of response
ResultSet / apiVersion Web API version
ResultSet / engineVersion Engine version
ResultSet / Condition Element representing detailed search condition

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:"
  }
}