api.cruiseway.gr (1.1.0)

Download OpenAPI specification:Download

E-mail: [email protected] License: Proprietary license

Auth

Login

Logs a user into the system and returns an authentication token.

Request Body schema: application/json

email required	string <email>
password required	string <password>

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"password": "pa$$word"
}

Response samples

201
400
422

Content type

application/json

{"success": true,
"data": {"id": 0,
"name": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"token": "string",
"account": {"state": "string",
"city": "string",
"address": "string",
"post_code": "string",
"country_id": 0,
"phone_extension": "string",
"phone": "string",
"emergency_name": "string",
"emergency_phone_extension": "string",
"emergency_phone": "string",
"newsletter": true
}
},
"message": "string"
}

Logout

Logs out the user by potentially invalidating the token on the server-side (optional) and requires a bearer token in the Authorization header.

Authorizations:

bearerAuth

Responses

Response samples

401

Content type

application/json

{"message": "string"
}

Register

Registers a new user into the system and returns an authentication token.

Request Body schema: application/json

firstname required	string
lastname required	string
email required	string <email>
password required	string <password>
password_confirmation required	string <password>

Responses

Request samples

Payload

Content type

application/json

{"firstname": "string",
"lastname": "string",
"email": "[email protected]",
"password": "pa$$word",
"password_confirmation": "pa$$word"
}

Response samples

201
422

Content type

application/json

{"success": true,
"data": {"id": 0,
"name": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"token": "string",
"account": {"state": "string",
"city": "string",
"address": "string",
"post_code": "string",
"country_id": 0,
"phone_extension": "string",
"phone": "string",
"emergency_name": "string",
"emergency_phone_extension": "string",
"emergency_phone": "string",
"newsletter": true
}
},
"message": "string"
}

Send password reset link

Request Body schema: application/json

email

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]"
}

Response samples

200

Content type

application/json

null

Reset Password

Resets a user's password and returns an authentication token.

Request Body schema: application/json

token required	string
email required	string <email>
password required	string <password>
password_confirmation required	string <password>

Responses

Request samples

Payload

Content type

application/json

{"token": "string",
"email": "[email protected]",
"password": "pa$$word",
"password_confirmation": "pa$$word"
}

Response samples

200
422

Content type

application/json

null

Content

Get Filters

Returns a list of filters for the content.

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"data": [{"value": 0,
"label": "string"
}
],
"message": "string"
}

Newsletter

Insert a new subscriber in the our newsletter list.

Request Body schema: application/json

email required	string <email>
name	string

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"name": "string"
}

Response samples

201
422

Content type

application/json

{"success": true,
"data": {"id": 0,
"email": "string",
"name": "string",
"created_at": "string",
"updated_at": "string"
}
}

Cruises

Get Cruises

Get cruise list with filters in a length-aware paginated format.

query Parameters

brand[]	Array of arrays Example: brand[]=1&brand[]=2 The brand to filter cruises by.
destination[]	Array of arrays Example: destination[]=1&destination[]=2 The destination to filter cruises by.
duration[]	Array of arrays Example: duration[]=1&duration[]=2 The duration to filter cruises by.
page	integer >= 1 Default: 1 The page number to retrieve.
port[]	Array of arrays Example: port[]=1&port[]=2 The port to filter cruises by.
price[]	Array of arrays Example: price[]=1&price[]=2 The price to filter cruises by.
brand[]	Array of arrays Example: brand[]=1&brand[]=2 The brand to filter cruises by.

Responses

Response samples

201

Content type

application/json

{"success": true,
"message": "string",
"data": {"current_page": 0,
"data": [{"id": 0,
"code": "string",
"title": "string",
"vessel": {"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"media": {"primary_image": {"original": "string"
}
}
},
"duration": 0,
"departure_at": "string",
"departure_at_raw": null,
"port": {"id": 0,
"name": "string",
"code": "string",
"country": {"id": 0,
"name": "string"
}
},
"booked_status": "string"
}
],
"first_page_url": "string",
"from": 0,
"last_page": 0,
"last_page_url": "string",
"links": [{"url": "string",
"label": "string",
"active": true
}
],
"next_page_url": "string",
"path": "string",
"per_page": 0,
"prev_page_url": "string",
"to": 0,
"total": 0
}
}

Get Cruise

Get cruise details by ID.

path Parameters

cruiseId

required

integer

ID of the Cruise

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": {"id": 0,
"code": "string",
"title": "string",
"vessel": {"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"media": {"primary_image": {"original": "string"
}
}
},
"duration": 0,
"departure_at": "string",
"departure_at_raw": null,
"port": {"id": 0,
"name": "string",
"code": "string",
"country": {"id": 0,
"name": "string"
}
},
"booked_status": "string"
}
}

Get Cruise for Booking

Get cruise details by ID for booking.

path Parameters

cruiseId

required

integer

ID of the Cruise

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": {"id": 0,
"code": "string",
"title": "string",
"vessel": {"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"media": {"primary_image": {"original": "string"
}
}
},
"duration": 0,
"departure_at": "string",
"departure_at_raw": null,
"port": {"id": 0,
"name": "string",
"code": "string",
"country": {"id": 0,
"name": "string"
}
},
"booked_status": "string"
}
}

Get Cruise Category Prices for Booking

Get cruise category prices by ID for booking.

Request Body schema: application/json

cruise_id required	integer
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"cruise_id": 0,
"cabins": [{"cabin": [{"id": 0
}
],
"participants": [{"age": 0
}
]
}
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": {"id": 0,
"code": "string",
"title": "string",
"vessel": {"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"media": {"primary_image": {"original": "string"
}
}
},
"duration": 0,
"departure_at": "string",
"departure_at_raw": null,
"port": {"id": 0,
"name": "string",
"code": "string",
"country": {"id": 0,
"name": "string"
}
},
"booked_status": "string"
}
}