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 : request parameter for gangway security movement
Type:
objectTitle:
request parameter for gangway security movementrequest parameter for gangway security movement
Show Source
-
gateLocation:
string
Example:
Guest Gangway -
gateMovement:
string
Example:
Coming On-board -
reservationId:
number
Example:
989322 -
workStation:
string
Example:
CPKWAN-I7
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : newGangwayActivitiesPost
Type:
objectGangway Activities inserted into GLG table
Show Source
-
directionCode:
string
Example:
DIR -
gangwayActivityId:
number
Minimum Value:
1Maximum Value:99999999Example:1 -
gateActivityFacerecResult:
string
Example:
example -
gateActivityModDate:
string
Example:
2019-08-21 -
gateActivityName:
string
Example:
Fiona -
gateActivityShoreDenied:
boolean
Example:
true -
gateActivityUsrId:
number
Example:
1 -
gateLocation:
string
Pattern:
^[a-zA-Z0-9 ]*$Example:Guest Gangway -
gateMovement:
string
Pattern:
^[a-zA-Z0-9 ]*$Example:Coming On-board -
movementCode:
string
Example:
COB -
movementDate:
string
Example:
2019-08-21 -
reservationDetails:
object reservationDetail
reservation Details
-
reservationId:
number
Example:
989322 -
swipeCard:
boolean
Example:
true -
workStation:
string
Pattern:
^[a-zA-Z0-9 ]*$Example:BERNICEW8
Nested Schema : reservationDetail
Type:
objectreservation Details
Show Source
-
accountId:
number
Example:
25152 -
actualEmbarkDate:
string
Example:
2010-07-09 -
actualEmbarkPCDate:
string
Example:
2010-07-09 -
boardCardNumber:
string
Example:
980000000099379200 -
cabinNum:
string
Example:
488 -
checkedDocuments:
string
Example:
Y -
collectedDocuments:
string
Example:
Y -
consentStatus:
boolean
Example:
true -
disembarkDate:
string
Example:
2012-04-30 -
disembarkPort:
number
Example:
49002 -
embarkCruiseId:
number
Example:
10582 -
embarkDate:
string
Example:
2010-07-09 -
embarkPort:
number
Example:
49002 -
genericDenyBoarding:
string
Example:
Y -
groupReferenceId:
number
Example:
1024564 -
onboardStatus:
boolean
Example:
false -
paymentMethod:
string
Example:
0 -
reservationAccountReferenceId:
number
Example:
1025729 -
reservationAccountType:
string
Example:
C -
reservationBookingNumber:
string
Example:
4679306 -
reservationCancelStatus:
boolean
Example:
true -
reservationExternalId:
string
Example:
11713343SI100731LL -
reservationId:
number
Example:
989322 -
reservationStatus:
string
Example:
DD -
routedAccountNumber:
number
Example:
1011512 -
setSailPass:
string
Example:
pass -
systemRandomNumber:
number
Example:
123111
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
409 Response
Conflict
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source