Retrieve list of all public locations
get
/spms/v2/ships/{shipId}/configurations/locations
This is to retrieve a list of all public locations
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship ID
Query Parameters
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset
-
status: boolean
-
title: string
Response
Supported Media Types
- applicaton/json
200 Response
OK
Root Schema : GetAllLocations
Type:
object
Title:
Show Source
GetAllLocations
-
count(optional):
integer
The total number of items in the list.Example:
2
-
hasMore(optional):
boolean
Flag which indicates whether or not there are more items.Example:
false
-
items(optional):
array items
-
limit(optional):
integer
The size of items in the list.Example:
10
-
offset(optional):
integer
The page of items in the list.Example:
0
Nested Schema : items
Type:
Show Source
array
-
Array of:
object GetLocation
Title:
GetLocation
Example:
[
{
"id":1001,
"code":"pool",
"title":"Baby Club Chicco",
"description":"Pool Side",
"comment":"30 meter within the pool",
"status":true,
"deck":"7",
"deckName":"Roof Top",
"shouldWarnIfOverLap":false,
"picFileName":"RoofTop.jpg"
},
{
"id":1009,
"code":"meet",
"title":"Boutique",
"description":"Meeting room",
"comment":"room 3",
"status":false,
"deck":"3",
"deckName":"deck 3",
"shouldWarnIfOverLap":false,
"picFileName":"deck3.jpg"
}
]
Nested Schema : GetLocation
Type:
object
Title:
Show Source
GetLocation
-
code(optional):
string
location codeExample:
Pool
-
comment(optional):
string
location commentExample:
oracle.doceng.json.BetterJsonNull@38379575
-
deck(optional):
string
location deck
-
deckName(optional):
string
deck name
-
description(optional):
string
location descriptionExample:
Study Room
-
id(optional):
integer
This value is refer to Location ID number.Example:
1001
-
picFileName(optional):
string
location picture filename
-
shouldWarnIfOverlap(optional):
boolean
location overlap book (true - Warn, false - Do not Warn)
-
status(optional):
boolean
The status of the locationExample:
true
-
title(optional):
string
The location titleExample:
Art Gallery
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.2",
"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":"Unauthorized",
"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