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

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

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.27.0.0" engineVersion="202303_01a">
  <Condition>T32212332322191:F33211221200001:A23121141:</Condition>
</ResultSet>

GET /v1/json/toolbox/course/condition?key=your_access_key_here&plane=normal&walk=little

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "202303_01a",
    "Condition": "T32212332322191:F33211221200001:A23121141:"
  }
}