Search for autocomplete

GET 
/autocomplete/:what

Search for a specific resource in auto complete fields

Request

Path Parameters

what stringrequired

Possible values: [country, airport, hotel, car-size, car-fuel]

Defines what to search for: country | airport | hotel | car-size | car-fuel

Query Parameters

query stringrequired

Search query

next string

If present in SearchResult this should be appended to the url as a query parameter in the format: ?next=[nextPageKey] in order to retrieve the next page with results

Responses

200

Result for search criteria

application/json

Schema

Schema

items

object[]

required

Search results

Array [

id stringrequired

Identifier for this search item (such as country code or other)

name stringrequired

Display name to show to the user

description string

Optional description to help the user

]

searchable booleanrequired

True if this response is searchable

nextPageKey string
If populated this should be appended to the url as a query parameter in the format:
?next=[nextPageKey]

Example (from schema)

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "searchable": true,
  "nextPageKey": "string"
}

400

Bad Request

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

401

Unauthorized client

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

403

Insufficient scope for accessing this resource

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

405

Method not allowed

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

500

Unexpected server error

application/json

Schema

Schema

errors

object[]

required

Detailed errors

Array [

source string

The application name that generated this error

reasonCode string

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

A unique constant identifying the error case encountered during request processing BAD_REQUEST - Malformed request, please advice the description and details fields for more information FORBIDDEN - Insufficient scope to access the resource INTERNAL_SERVER_ERROR - Unexpected server error METHOD_NOT_ALLOWED - Method not allowed UNSUPPORTED_MEDIA_TYPE - Unsupported media type

description string

Short description of the reasonCode field.

recoverable boolean

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "BAD_REQUEST",
      "description": "string",
      "recoverable": true,
      "details": "string"
    }
  ]
}

Loading...