Update profile other travel document details.
put
/spms/v2/ships/{shipId}/profiles/{profileTypes}/{profileId}/otherTravelDocuments/{documentId}
This is to update profile other travel document details.
Request
Supported Media Types
- application/json
Path Parameters
-
documentId: integer
Document Id
-
profileId: integer
Profile Id
-
profileTypes: string
Profile typesAllowed Values:
[ "guest", "crew", "resident", "visitor", "staff" ]
-
shipId: integer
Ship Id
Root Schema : Other Travel Documents Request
Type:
object
Title:
Other Travel Documents Request
Other Travel Documents Request
Show Source
-
birthCertificateState(optional):
string
Maximum Length:
6
Birth Certificate StateExample:KL
-
documentAdditionalNote1(optional):
string
Maximum Length:
50
Additional notes 1Example:remark
-
documentAdditionalNote2(optional):
string
Maximum Length:
50
Additional notes 2Example:remark
-
documentBirthDate(optional):
string
Document BirthdateExample:
1961-04-01T16:00:00.0Z
-
documentComments(optional):
string
Maximum Length:
3000
Comments, use by DGS onlyExample:comment
-
documentExpiryDate(optional):
string
Document Expiry DateExample:
1961-04-01T16:00:00.0Z
-
documentFirstName(optional):
string
Maximum Length:
40
Document First NameExample:John
-
documentGUID(optional):
string
Maximum Length:
50
Document GUIDExample:6AF13A4B-0A02-4435-B6E9-FC4BEFB465E2
-
documentImportUniqueId(optional):
string
Unique IDExample:
10450919
-
documentIssuedCountryCode(optional):
string
Maximum Length:
6
Document Issued Country CodeExample:CN
-
documentIssuedDate(optional):
string
Document Issued DateExample:
1961-04-01T16:00:00.0Z
-
documentIssuedPlace(optional):
string
Maximum Length:
40
Document Issued PlaceExample:CHN
-
documentLastName(optional):
string
Maximum Length:
40
Document Last NameExample:John
-
documentMiddleName(optional):
string
Maximum Length:
20
Document Middle NameExample:John
-
documentMRZ1(optional):
string
Maximum Length:
100
Machine Readable Track 1 informationExample:IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
-
documentMRZ2(optional):
string
Maximum Length:
100
Machine Readable Track 2 informationExample:IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
-
documentMRZ3(optional):
string
Maximum Length:
100
Machine Readable Track 3 informationExample:IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
-
documentMultipleEntries(optional):
string
Multiple entries of visaExample:
1
-
documentNumber(optional):
string
Maximum Length:
20
Document NumberExample:AO292152
-
documentNumberOfEntries(optional):
integer
Number of EntryExample:
1
-
documentRegisteredAtWizard(optional):
boolean
Travel document that is registered at AQCI WizardExample:
false
-
documentRemoteId(optional):
string
Maximum Length:
30
Remote IdExample:999000544
-
documentRemoteManifestUpdatedDate(optional):
string
Document Remote Manifest Updated DateExample:
1961-04-01T16:00:00.0Z
-
documentValidFromDate(optional):
string
Valid From DateExample:
1961-04-01T16:00:00.0Z
-
durationOfStay(optional):
integer
Duration of StayExample:
1
-
photoIdState(optional):
string
Maximum Length:
6
Photo Id StateExample:KL
-
photoIdType(optional):
string
Maximum Length:
10
Photo Id TypeExample:1
-
travelDocumentTypeCode(optional):
string
Maximum Length:
6
Travel Document Type CodeExample:V
-
travelDocumentTypeName(optional):
string
Maximum Length:
100
Travel Document Type NameExample:Passport
-
visaType(optional):
string
Maximum Length:
6
Visa TypeExample:P
Response
Supported Media Types
- application/json
200 Response
Updated
Root Schema : Other Travel Documents
Type:
object
Title:
Other Travel Documents
Other Travel Documents
Show Source
-
birthCertificateState(optional):
string
Maximum Length:
6
Birth Certificate StateExample:KL
-
documentAdditionalNote1(optional):
string
Maximum Length:
50
Additional notes 1Example:remark
-
documentAdditionalNote2(optional):
string
Maximum Length:
50
Additional notes 2Example:remark
-
documentBirthDate(optional):
string
Document BirthdateExample:
1961-04-01T16:00:00.0Z
-
documentComments(optional):
string
Maximum Length:
3000
Comments, use by DGS onlyExample:comment
-
documentExpiryDate(optional):
string
Document Expiry DateExample:
1961-04-01T16:00:00.0Z
-
documentFirstName(optional):
string
Maximum Length:
40
Document First NameExample:John
-
documentGUID(optional):
string
Maximum Length:
50
Document GUIDExample:6AF13A4B-0A02-4435-B6E9-FC4BEFB465E2
-
documentId(optional):
integer
Minimum Value:
1
Pattern:^[0-9]*$
Document IDExample:1001
-
documentImportUniqueId(optional):
string
Unique IDExample:
10450919
-
documentIssuedCountryCode(optional):
string
Maximum Length:
6
Document Issued Country CodeExample:CN
-
documentIssuedCountryDesc(optional):
string
Document Issued Country DescriptionExample:
China
-
documentIssuedDate(optional):
string
Document Issued DateExample:
1961-04-01T16:00:00.0Z
-
documentIssuedPlace(optional):
string
Maximum Length:
40
Document Issued PlaceExample:CHN
-
documentLastName(optional):
string
Maximum Length:
40
Document Last NameExample:John
-
documentMiddleName(optional):
string
Maximum Length:
20
Document Middle NameExample:John
-
documentMRZ1(optional):
string
Maximum Length:
100
Machine Readable Track 1 informationExample:IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
-
documentMRZ2(optional):
string
Maximum Length:
100
Machine Readable Track 2 informationExample:IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
-
documentMRZ3(optional):
string
Maximum Length:
100
Machine Readable Track 3 informationExample:IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
-
documentMultipleEntries(optional):
string
Multiple entries of visaExample:
1
-
documentNumber(optional):
string
Maximum Length:
20
Document NumberExample:AO292152
-
documentNumberOfEntries(optional):
integer
Number of EntryExample:
1
-
documentRegisteredAtWizard(optional):
boolean
Travel document that is registered at AQCI WizardExample:
false
-
documentRemoteId(optional):
string
Maximum Length:
30
Remote IdExample:999000544
-
documentRemoteManifestUpdatedDate(optional):
string
Document Remote Manifest Updated DateExample:
1961-04-01T16:00:00.0Z
-
documentValidFromDate(optional):
string
Valid From DateExample:
1961-04-01T16:00:00.0Z
-
durationOfStay(optional):
integer
Duration of StayExample:
1
-
lastModifiedDate(optional):
string
Last Modified DateExample:
1961-04-01T16:00:00.0Z
-
photoIdState(optional):
string
Maximum Length:
6
Photo Id StateExample:KL
-
photoIdType(optional):
string
Maximum Length:
10
Photo Id TypeExample:1
-
profileId(optional):
integer
Profile IDExample:
1001
-
travelDocumentTypeCode(optional):
string
Maximum Length:
6
Travel Document Type CodeExample:V
-
travelDocumentTypeDesc(optional):
string
Travel Document Type DescriptionExample:
Visa
-
travelDocumentTypeName(optional):
string
Maximum Length:
100
Travel Document Type NameExample:Passport
-
visaType(optional):
string
Maximum Length:
6
Visa TypeExample:P
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":"The parameter shipId has incorrect format"
}
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource is 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":"Profile Id 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":"http://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":"HTTP://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