NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve list of all enabled gate locations
get
/spms/v1/configurations/gangwayGateLocations/enabled
This is to retrieve a list of all enabled gate locations
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful Response
Nested Schema : gateLocations
Type:
object
Title:
Show Source
gateLocations
-
code(optional):
string
Example:
G1
-
enabledFlag(optional):
boolean
Example:
true
-
entity(optional):
string
Example:
GWL
-
name(optional):
string
Example:
Gangway Deck 1
Example Response (application/json)
[
{
"entity":"GWL",
"name":"Deck 3 Crew Portside",
"code":"3CPORT",
"enabledFlag":true
}
]
401 Response
Unauthorized
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
This API is not allowed for your current user role
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
Not Found
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occured while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1