NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
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:
objectTitle:
Error Response DetailDetailed 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 : newGangwayActivitiesResponse
Type:
objectGangway Activities inserted into GLG table
Show Source
-
directionCode(optional):
string
Example:
DIR -
gangwayActivityId(optional):
number
Minimum Value:
1Maximum Value:99999999Example: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:
objectreservation 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
Unknown request found
401 Response
You do not have valid authorization
403 Response
You are not authorized to use the service
404 Response
Record not found
415 Response
Content format not supported
500 Response
Internal server error occurred