Update the opened tender boat gateway details
put
/spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/{tenderBoatGatewayId}
This is to update the opened tender boat gateway details by record id
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship ID
-
tenderBoatGatewayId: number(12345678)
Tender Boat Gateway ID
Root Schema : UpdateTenderBoatGatewayInformationRequest
Type:
Show Source
object
-
tenderBoatStatus(optional):
boolean
true is opening , false is closedExample:
true
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : GetTenderBoatGatewayInformationResponse
Match All
Show Source
-
object
GetTenderBoatGatewayInformationResponse-allOf[0]
-
object
TenderBoatGatewayInformation
Title:
TenderBoatGatewayInformation
Nested Schema : GetTenderBoatGatewayInformationResponse-allOf[0]
Type:
Show Source
object
-
dateTime(optional):
string
Opened tender boat datetimeExample:
2013-07-16T19:23
-
id(optional):
number
Tender boat gateway idExample:
12345678
-
locationName(optional):
string
Location NameExample:
Gangway A Entrance
-
tenderBoatGatewayUsers(optional):
array tenderBoatGatewayUsers
-
tenderBoatName(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Example:Tender boat 1
-
tenderBoatStatus(optional):
boolean
true is opening , false is closedExample:
true
Nested Schema : TenderBoatGatewayInformation
Type:
object
Title:
Show Source
TenderBoatGatewayInformation
-
direction(optional):
string
This is the tender boat direction, 1 = Outward, 2 = Inward onlyExample:
1
-
locationCode(optional):
string
Location codeExample:
GA1
-
tenderBoatId(optional):
number
Tender Boat IDExample:
12345678
Nested Schema : TenderBoatGatewayUserInformation-allOf[0]
Type:
Show Source
object
-
id(optional):
number
User idExample:
123456
-
name(optional):
string
User nameExample:
user1
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":"Invalid status"
}
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
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":"The specified tender boat gateway cannot be 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
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