Create a guest cruise reservation
post
/spms/v2/ships/{shipId}/reservations/guests
This is to create a guest cruise reservation
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number
Ship Id
Guest Reservation Post Object
Root Schema : guestReservationPOSTObject
Type:
object
Guest Reservation POST Object
Show Source
-
boardCardNumber(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Board Card NumberExample:100500333
-
bookingNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
Booking NumberExample:123456789
-
discountTemplateCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Discount Template CodeExample:A1
-
disembarkationDate(optional):
string(date)
Disembarkation DateExample:
2018-11-11
-
disembarkationHarborCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Disembarkation Harbor CodeExample:D1
-
disembarkationHarborComments(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
commentsExample:Going to the land
-
document(optional):
object document
Document
-
embarkationDate(optional):
string(date)
Embarkation DateExample:
2018-11-11
-
embarkationHarborCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Embarkation Harbor CodeExample:E1
-
embarkationHarborComments(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
commentsExample:Going to the sea
-
isNoticeAndConsent(optional):
boolean
Acknowledge Notice and ConsentExample:
true
-
lifeBoatCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Lifeboat CodeExample:L1
-
manifestPrintOut(optional):
boolean
Manifest PrintoutExample:
false
-
musterStationCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Musterstation CodeExample:M1
-
numberOfCruiseDays(optional):
number
Pattern:
^[0-9]*$
Total Number Of Cruise DaysExample:1
-
numberOfCruises(optional):
number
Pattern:
^[0-9]*$
Number Of CruisesExample:1
-
onboardEmail(optional):
string
Minimum Length:
1
Maximum Length:49
Pattern:^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$
Onboard Email Address * `null` if emptyExample:oneworld@gmail.com
-
onboardStatus(optional):
boolean
onboardStatusExample:
false
-
otherParameters(optional):
object otherParameters
Other Parameters
-
profileInformation(optional):
object profileInformationPOST
Profile Information for Post
-
queueId(optional):
number
Pattern:
^[0-9]*$
Queue IdExample:11
-
setSailPassNumber(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Set Sail Pass NumberExample:3388
-
shoreGId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Shore G IdExample:G1
-
shoreResId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Shore Reservation IdExample:S1
-
stateroomNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
stateroomNumberExample:1001
Nested Schema : document
Type:
object
Document
Show Source
-
isDocumentChecked(optional):
boolean
Document Is CheckedExample:
false
-
isDocumentCollected(optional):
boolean
Document Is CollectExample:
false
Nested Schema : otherParameters
Type:
object
Other Parameters
Show Source
-
isAirSeaOperator(optional):
boolean
Is Air Sea OperatorExample:
false
-
isChargeCheckedOutCalls(optional):
boolean
Is Charge For Checked Out CallsExample:
false
-
isCompleteOnlineForm(optional):
boolean
Is Complete Online FormExample:
false
-
isExpressCheckOut(optional):
boolean
Is Express CheckoutExample:
false
-
isGroupLeader(optional):
boolean
Is Group LeaderExample:
false
-
isKioskCheckInAllowed(optional):
boolean
Is Kiosk Check In AllowedExample:
false
-
isNonInclusiveGuestType(optional):
boolean
Is Non Inclusive Guest TypeExample:
false
-
isResident(optional):
boolean
Is ResidentExample:
false
-
isStayOvernightTour(optional):
boolean
Is Stay Overnight TourExample:
false
-
isSwitchToCrewManifest(optional):
boolean
Is Switch To Crew ManifestExample:
false
Nested Schema : profileInformationPOST
Type:
object
Profile Information for Post
Show Source
-
birthPlace(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Birth PlaceExample:Kajang
-
dateOfBirth(optional):
string(date)
Birth DateExample:
2018-11-11
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
First NameExample:Fabiana
-
genderCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Gender CodeExample:M
-
guestCategoryCodes(optional):
array guestCategoryPOST
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Last NameExample:Carleo
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Middle NameExample:Alberto
-
nationalId(optional):
string
Minimum Length:
1
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
National IdExample:22
-
nationalityCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Nationality CodeExample:MY
-
otherFirstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other First NameExample:Frost
-
otherLastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other Last NameExample:Francis
-
passportIssuedCountryCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport Issued Country CodeExample:MY
-
passportIssuedDate(optional):
string(date)
Passport Issued DateExample:
2018-11-11
-
passportIssuedExpiryDate(optional):
string(date)
Passport Issued Expiry DateExample:
2018-11-11
-
passportIssuedPlace(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport Issued PlaceExample:Shah Alam
-
passportNumber(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport NumberExample:A145611
-
permanentResidentId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Permanent ResidentExample:P123
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z]
SalutationExample:MR
-
vipCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
VIP CodeExample:V1
Nested Schema : guestCategoryPOST
Type:
Show Source
array
-
Array of:
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Guest Category CodesExample:GC1
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : guestReservationGETObject
Type:
object
Guest Reservation GET Object
Show Source
-
boardCardNumber(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Board Card NumberExample:100500333
-
bookingNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
Booking NumberExample:123456789
-
discountTemplate(optional):
object discountTemplate
Discount Template
-
disembarkationDate(optional):
string(date)
Disembarkation DateExample:
2018-11-11
-
disembarkationHarbor(optional):
object disembarkationHarbor
disembarkationHarbor
-
disembarkationHarborComments(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
commentsExample:Going to the land
-
document(optional):
object document
Document
-
embarkationDate(optional):
string(date)
Embarkation DateExample:
2018-11-11
-
embarkationHarbor(optional):
object embarkationHarbor
Embarkation Harbor
-
embarkationHarborComments(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
commentsExample:Going to the sea
-
isNoticeAndConsent(optional):
boolean
Acknowledge Notice and ConsentExample:
true
-
lifeBoat(optional):
object lifeBoat
Life Boat
-
manifestPrintOut(optional):
boolean
Manifest PrintoutExample:
false
-
musterStation(optional):
object musterStation
musterStation
-
numberOfCruiseDays(optional):
number
Pattern:
^[0-9]*$
Total Number Of Cruise DaysExample:1
-
numberOfCruises(optional):
number
Pattern:
^[0-9]*$
Number Of CruisesExample:1
-
onboardEmail(optional):
string
Minimum Length:
1
Maximum Length:49
Pattern:^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$
Onboard Email Address * `null` if emptyExample:oneworld@gmail.com
-
onboardStatus(optional):
boolean
onboardStatusExample:
false
-
otherParameters(optional):
object otherParameters
Other Parameters
-
profileInformation(optional):
object profileInformation
Profile Information
-
queueId(optional):
number
Pattern:
^[0-9]*$
Queue IdExample:11
-
reservationId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Reservation IdExample:1001
-
reservationStatus(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Reservation Status, RR=Reservation, RX=Cancelled, RE=Embark today, RN=No Show, CC=Checked In, CL=Leaving today, DD=DisembarkedExample:CC
-
setSailPassNumber(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Set Sail Pass NumberExample:3388
-
shoreGId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Shore G IdExample:G1
-
shoreResId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Shore Reservation IdExample:S1
-
stateroomNumber(optional):
string
Minimum Length:
1
Pattern:^[a-zA-Z0-9]+$
stateroomNumberExample:1001
Nested Schema : discountTemplate
Type:
object
Discount Template
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Discount Template CodeExample:A1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Discount Template Code DescriptionExample:Loyal Guest
Nested Schema : disembarkationHarbor
Type:
object
disembarkationHarbor
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Disembarkation Harbor CodeExample:D1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Disembarkation Harbor Code DescriptionExample:To Land
Nested Schema : document
Type:
object
Document
Show Source
-
isDocumentChecked(optional):
boolean
Document Is CheckedExample:
false
-
isDocumentCollected(optional):
boolean
Document Is CollectExample:
false
Nested Schema : embarkationHarbor
Type:
object
Embarkation Harbor
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Embarkation Harbor CodeExample:E1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Embarkation Harbor Code DescriptionExample:To Sea
Nested Schema : lifeBoat
Type:
object
Life Boat
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Lifeboat CodeExample:L1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Lifeboat Code DescriptionExample:Guest Boat A
Nested Schema : musterStation
Type:
object
musterStation
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Musterstation CodeExample:M1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Musterstation Code DescriptionExample:Guest Deck 1
Nested Schema : otherParameters
Type:
object
Other Parameters
Show Source
-
isAirSeaOperator(optional):
boolean
Is Air Sea OperatorExample:
false
-
isChargeCheckedOutCalls(optional):
boolean
Is Charge For Checked Out CallsExample:
false
-
isCompleteOnlineForm(optional):
boolean
Is Complete Online FormExample:
false
-
isExpressCheckOut(optional):
boolean
Is Express CheckoutExample:
false
-
isGroupLeader(optional):
boolean
Is Group LeaderExample:
false
-
isKioskCheckInAllowed(optional):
boolean
Is Kiosk Check In AllowedExample:
false
-
isNonInclusiveGuestType(optional):
boolean
Is Non Inclusive Guest TypeExample:
false
-
isResident(optional):
boolean
Is ResidentExample:
false
-
isStayOvernightTour(optional):
boolean
Is Stay Overnight TourExample:
false
-
isSwitchToCrewManifest(optional):
boolean
Is Switch To Crew ManifestExample:
false
Nested Schema : profileInformation
Type:
object
Profile Information
Show Source
-
birthPlace(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Birth PlaceExample:Kajang
-
dateOfBirth(optional):
string(date)
Birth DateExample:
2018-11-11
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
First NameExample:Fabiana
-
gender(optional):
object gender
Gender
-
guestCategories(optional):
array guestCategory
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Last NameExample:Carleo
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Middle NameExample:Alberto
-
nationalId(optional):
string
Minimum Length:
1
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
National IdExample:22
-
nationality(optional):
object nationality
Nationality
-
otherFirstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other First NameExample:Frost
-
otherLastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Other Last NameExample:Francis
-
passportIssuedCountry(optional):
object passportIssuedCountry
Passport Issued Country
-
passportIssuedDate(optional):
string(date)
Passport Issued DateExample:
2018-11-11
-
passportIssuedExpiryDate(optional):
string(date)
Passport Issued Expiry DateExample:
2018-11-11
-
passportIssuedPlace(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport Issued PlaceExample:Shah Alam
-
passportNumber(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport NumberExample:A145611
-
permanentResidentId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Permanent ResidentExample:P123
-
profileId(optional):
integer
Minimum Value:
1
Pattern:^[0-9]*$
Profile IDExample:1001
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z]
SalutationExample:MR
-
vip(optional):
object vip
VIP
Nested Schema : gender
Type:
object
Gender
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Gender CodeExample:M
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Gender Code DescriptionExample:Male
Nested Schema : guestCategory
Type:
Show Source
array
-
Array of:
object guestCategoryGroup
Guest Category Group
Nested Schema : nationality
Type:
object
Nationality
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Nationality CodeExample:MY
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Nationality Code DescriptionExample:Malaysia
Nested Schema : passportIssuedCountry
Type:
object
Passport Issued Country
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport Issued Country CodeExample:MY
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Passport Issued Country Code DescriptionExample:Malaysia
Nested Schema : vip
Type:
object
VIP
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
VIP CodeExample:V1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
VIP Code DescriptionExample:Minister
Nested Schema : guestCategoryGroup
Type:
object
Guest Category Group
Show Source
-
code(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Guest Category CodesExample:GC1
-
description(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Guest Category Codes DescriptionExample:Couple
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 parameter(s) passed in"
}
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 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":"Ship Id could not be found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Supported
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
410 Response
Gone
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.11",
"title":"Gone",
"detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Invalid content
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
501 Response
Not Implemented
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.2",
"title":"Not implemented",
"detail":"Resource is not implemented in this version of the API"
}
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":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source