Retrieve the gateway security activities with criterias.
get
/spms/v2/ships/{shipId}/gatewaySecurity/activities
This is to retrieve the gateway security activities with criterias
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship Identifier number
Query Parameters
-
fullName(optional): string
Full name is combination of First Name, Middle Name or Last Name
-
gateMovement(optional): string
Gateway Security movement types
-
limit: integer(int32)
Paging limit
-
locationName(optional): string
Location name
-
movementDatetimeFrom(optional): string
Start datetime of movement
-
movementDatetimeTo(optional): string
End datetime of movement
-
offset: integer(int32)
Paging offset
-
orderBy(optional): string(stateroom:asc)
Sorting records by columns in ascending or descending. Format: column name:asc or desc. if multiple columns needed then split it by comma
-
profileId(optional): number(12345678)
Profile identifier Number
-
profileType(optional): array
Profile types like Guest(P), Resident(R), Crew(C), Visitor(V)
-
searchValue(optional): string
The search value allow to search full name or stateroom
-
stateroom(optional): string
Stateroom
-
tenderBoatId(optional): number(12345678)
Tender boat identifier number
Nested Schema : items
Type:
array
Allowed Values:
[
"P",
"R",
"C",
"V"
]
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Oracle Responses - All gateway security activities
Title:
Oracle Responses - All gateway security activities
The wrapper object when returning successful values in Oracle standard
Nested Schema : Oracle Responses - All gateway security activities
Type:
object
Title:
Oracle Responses - All gateway security activities
The wrapper object when returning successful values in Oracle standard
Show Source
-
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 Oracle Responses - Gateway security activities
Title:
Oracle Responses - Gateway security activities
The wrapper object when returning successful values in Oracle Standard
Nested Schema : Oracle Responses - Gateway security activities
Type:
object
Title:
Oracle Responses - Gateway security activities
The wrapper object when returning successful values in Oracle Standard
Show Source
-
fullName(optional):
string
Example:
Full Name
-
gateMovement(optional):
string
Example:
Coming On-board
-
Id(optional):
number
Example:
12345
-
locationName(optional):
string
Example:
Gangway A
-
movementDate(optional):
string
Example:
2020-01-31T00:00:00
-
profileId(optional):
number
Example:
123456
-
profileType(optional):
string
Example:
P
-
stateroom(optional):
string
Example:
C1001
-
swipeCard(optional):
string
Example:
No
-
tenderBoatId(optional):
number
Example:
1234567
-
tenderBoatName(optional):
string
Example:
Tender Boat A
-
userName(optional):
string
Example:
username
-
workStation(optional):
string
Example:
WK101
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.1",
"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