FindDetailedLocations

Description: Retrieves a list of available locations based on a search string and location type (from/to).

Test Endpoint: `[Endpoint URL provided by National Express]`

Live Endpoint: `[Endpoint URL provided by National Express]`

Method: `GET` (or `POST` depending on implementation details)

Type	Required?	Description
partnerIdentifier	Mandatory	See section 9.1
locationType	Mandatory	Must be either “from” or “to”
nameSearch	Optional	If absent it will cause the web service to return all (potentially  1000+) locations for the given Location Type  If present it must contain at least 3 characters (there is no maximum) and will cause the search to only return those  locations that contain the provided string (case insensitive).  There are no maximum characters Wildcard characters are supported, for example Stratford Upon-Avon, Westward Ho! Supported wildcard characters are  “,” “(“ “)” “.” “-“ “/” “!” “’”

Response Data 

The response contains a list of Locations with their Short Description and a Location Code. It is Important to note that the Data Structure for all the response tags is JSON String

Reference table for location information. 

• code: An attribute containing a location identifier.
• name: Short description of the location E.g. London Baker Street Station.
• displayName: Detailed description of location including any stop specific detail designed for display. E.g. London, Baker Street Station (out of London EXCEPT to Luton Airport: Gloucester Place, Stop 19; to Luton Airport ONLY: Gloucester Place, Stop S; or, into London: Baker Street, Stop A), Greater London.
• stop: The name of the stop for display. E.g. London (Baker Street Stn).
• street: Street Name of location.
• town: Town name of location if applicable.
• county: County name of location if applicable.
• country: County name where this location is.
• stopLatitude: The Latitude coordinates of the location. E.g. 51.52212.
• stopLongitude: The Longitude coordinates of the location. E.g. -0.15992.
• main: Not Used.
• scotland: A binary indicator of whether this location is in Scotland.
• ireland: A binary indicator of whether this location is in Ireland.
• europe: A binary indicator of whether this location is in Mainland Europe.
• setDownPickUpOnly: Not Used.
• hotelFlag: A Boolean indicator of whether this location is at a hotel.
• airport: An indicator of whether this location is at an airport. “-“ indicates false, “Y” indicates true.
• checkInTime: The time by which the passenger needs to be at the stop location mentioned to board.
• mainStop: The location code of the Main Location associated with this location. For example: London Baker Street (57378) has a main stop of 57366 – London Victoria Coach Station.
• mainDisp: Whether this stop is a main stop in the area. “Y” = true, “N” or BLANK = false.
• digitalMediaLocationsId: Not Used.
• extraInfo: Important information for passengers regarding that location E.g. “PLEASE NOTE that until further notice, customers traveling out of London should join their coach c.150 yards further along Gloucester Pl (beyond Dorset Sq; near Huntsworth Mews). We apologize for the inconvenience so caused.”
• extraInfoFrom: The start date / time from which the extra info message is applicable.
• extraInfoTo: The end date / time until which the extra info message is applicable.
• locationType: For the list of “from” and “to” locations, this attribute indicates whether the location is domestic, European (excluding Ouibus), a Ouibus location, or an Irish location.