Retrieve the stateroom configuration with criterias.
get
/spms/v2/ships/{shipId}/configurations/staterooms
This is to retrieve the stateroom configuration with criterias
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship Identifier number
Query Parameters
-
limit: integer(int32)
Paging limit
-
noOfBerth(optional): number
No of Berth
-
offset: integer(int32)
Paging offset
-
orderBy(optional): string(stateroomId:asc)
Sorting records by columns in ascending or descending. Format: column name:asc or desc. if multiple columns needed then split it by comma
-
stateroomCategoryCode(optional): string
Stateroom Category Code
-
stateroomCategoryName(optional): string
Stateroom Category Name
-
stateroomFeatures(optional): string
Stateroom Features
-
stateroomId(optional): string
Stateroom Id
-
stateroomStatus(optional): string
Stateroom Status
-
stateroomType(optional): string
Stateroom types like Guest and Crew and Resident
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : All stateroom configuration
Type:
object
Title:
Show Source
All stateroom configuration
-
count(optional):
integer
The total number of items in the list.Example:
3
-
hasMore(optional):
boolean
Flag which indicates whether or not there are more items.Example:
false
-
items(optional):
array items
Nested Schema : items
Type:
Show Source
array
-
Array of:
object StateroomConfiguration
Title:
StateroomConfiguration
Nested Schema : StateroomConfiguration
Type:
object
Title:
Show Source
StateroomConfiguration
-
categoryCode(optional):
string
Example:
11
-
categoryName(optional):
string
Example:
Suite con balcone11
-
features(optional):
string
Example:
2B
-
stateroomId(optional):
string
Example:
12345678
-
stateroomType(optional):
string
Example:
guest
-
statusCode(optional):
string
Example:
OC
-
statusColorCode(optional):
string
Example:
16711680
-
statusName(optional):
string
Example:
Occupied Clean
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"limit must not be less than one!"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorised",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"Ship 123 was not found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Supported",
"detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source