Retrieve list of all staterooms
get
/spms/v1/configurations/staterooms
This is to retrieve a list of all staterooms
Request
Supported Media Types
- application/json
Query Parameters
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset
-
roomNumber: string
Search Value based on the room number
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Configure Staterooms Response object
Type:
object
Title:
Configure Staterooms Response object
The Configure Staterooms object when returning successful values
Show Source
-
count(optional):
integer
Example:
1
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
integer
Example:
5
-
offset(optional):
integer
Example:
1
Nested Schema : staterooms
Type:
object
Staterooms
Show Source
-
roomDesignation(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Example:guest
-
roomNumber(optional):
string
Minimum Value:
1
Maximum Value:100
Pattern:^[a-zA-Z ]*$
Example:1001
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Configure Staterooms Response object
Title:
Configure Staterooms Response object
The Configure Staterooms object when returning successful values
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"The parameter 'limit' has incorrect format"
}
Nested Schema : Configure Staterooms Response object
Type:
object
Title:
Configure Staterooms Response object
The Configure Staterooms object when returning successful values
Show Source
-
count(optional):
integer
Example:
1
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
integer
Example:
5
-
offset(optional):
integer
Example:
1
Nested Schema : staterooms
Type:
object
Staterooms
Show Source
-
roomDesignation(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Example:guest
-
roomNumber(optional):
string
Minimum Value:
1
Maximum Value:100
Pattern:^[a-zA-Z ]*$
Example:1001
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":"Unauthorized",
"detail":"You are not authorized to use this API"
}
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":"You are forbidden to use this API"
}
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
415 Response
Unsupported Media Type
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.16",
"title":"Invalid content",
"detail":"Content type not supported"
}
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 not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source