Create/ Add gangway activities for a profile
post
/spms/v1/gangwayActivities
This is to create/ add gangway activities for a profile
Request
Supported Media Types
- application/json
Required to create gangway activities
Root Schema : Error Response Detail
Type:
object
Title:
Error Response Detail
Detailed Error Response returned when encountered error
Show Source
-
gateLocation(optional):
string
Example:
Guest Gangway
-
gateMovement(optional):
string
Example:
Coming On-board
-
reservationId(optional):
number
Example:
989322
-
workStation(optional):
string
Example:
CPKWAN-I7
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : newGangwayActivitiesPost
Type:
object
Gangway Activities inserted into GLG table
Show Source
-
directionCode(optional):
string
Example:
DIR
-
gangwayActivityId(optional):
number
Minimum Value:
1
Maximum Value:99999999
Example:1
-
gateActivityFacerecResult(optional):
string
Example:
example
-
gateActivityModDate(optional):
string
Example:
2019-08-21
-
gateActivityName(optional):
string
Example:
Fiona
-
gateActivityShoreDenied(optional):
boolean
Example:
true
-
gateActivityUsrId(optional):
number
Example:
1
-
gateLocation(optional):
string
Pattern:
^[a-zA-Z0-9 ]*$
Example:Guest Gangway
-
gateMovement(optional):
string
Pattern:
^[a-zA-Z0-9 ]*$
Example:Coming On-board
-
movementCode(optional):
string
Example:
COB
-
movementDate(optional):
string
Example:
2019-08-21
-
reservationDetails(optional):
object reservationDetail
reservation Details
-
reservationId(optional):
number
Example:
989322
-
swipeCard(optional):
boolean
Example:
true
-
workStation(optional):
string
Pattern:
^[a-zA-Z0-9 ]*$
Example:BERNICEW8
Nested Schema : reservationDetail
Type:
object
reservation Details
Show Source
-
accountId(optional):
number
Example:
25152
-
actualEmbarkDate(optional):
string
Example:
2010-07-09
-
actualEmbarkPCDate(optional):
string
Example:
2010-07-09
-
boardCardNumber(optional):
string
Example:
980000000099379200
-
cabinNum(optional):
string
Example:
488
-
checkedDocuments(optional):
string
Example:
Y
-
collectedDocuments(optional):
string
Example:
Y
-
consentStatus(optional):
boolean
Example:
true
-
disembarkDate(optional):
string
Example:
2012-04-30
-
disembarkPort(optional):
number
Example:
49002
-
embarkCruiseId(optional):
number
Example:
10582
-
embarkDate(optional):
string
Example:
2010-07-09
-
embarkPort(optional):
number
Example:
49002
-
genericDenyBoarding(optional):
string
Example:
Y
-
groupReferenceId(optional):
number
Example:
1024564
-
onboardStatus(optional):
boolean
Example:
false
-
paymentMethod(optional):
string
Example:
0
-
reservationAccountReferenceId(optional):
number
Example:
1025729
-
reservationAccountType(optional):
string
Example:
C
-
reservationBookingNumber(optional):
string
Example:
4679306
-
reservationCancelStatus(optional):
boolean
Example:
true
-
reservationExternalId(optional):
string
Example:
11713343SI100731LL
-
reservationId(optional):
number
Example:
989322
-
reservationStatus(optional):
string
Example:
DD
-
routedAccountNumber(optional):
number
Example:
1011512
-
setSailPass(optional):
string
Example:
pass
-
systemRandomNumber(optional):
number
Example:
123111
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":"cannot be empty"
}
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
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
409 Response
Conflict
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.10",
"title":"Conflict",
"detail":"Resource ID already exists. Use an alternative ID"
}
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 Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source