Retrieve list of adult from search results
get
/spms/v1/guest/adults
This is to retrieve a list of adult profiles from search results to be associated to a minor as guardian
Request
Supported Media Types
- application/json
Query Parameters
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset
-
orderBy: string
-
profileSearchTemplate: integer(int32)
profile search template id
-
q: string
keyword(first name, last name, cabin number, booking number, passport number)
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Profile Search List
Type:
object
Title:
Profile Search List
The object returned in Oracle Standard when function is executed successfully
Show Source
-
count(optional):
integer
Example:
18
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
integer
Example:
2
-
links(optional):
array links
-
offset(optional):
integer
Example:
0
Nested Schema : ReturnSearchData
Type:
object
data return
Show Source
-
crew(optional):
object crewDetails
Crew information based on the Profile id passed
-
guest(optional):
object guestDetails
Guest information based on the Profile id passed
-
resident(optional):
object residentDetails
Resident information based on the Profile id passed
-
visitor(optional):
object visitorDetails
Visitor information based on the Profile id passed
Nested Schema : crewDetails
Type:
object
Crew information based on the Profile id passed
Show Source
-
accountId(optional):
integer
Minimum Value:
1
Example:12345
-
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]
Pattern:^A|P|C|G|V|O$
Example:System Account, Passenger, Crew, Group, Visitor
-
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09
-
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
Example:57
-
alternativeContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
assemblyStationCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-z0-9]
Example:12345
-
assemblyStationName(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
cabinNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:11111
-
classification(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:[VIP]
-
consentStatus(optional):
integer
Example:
0
-
contactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
countryOfBirth(optional):
string
Minimum Length:
1
Maximum Length:3
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
countryOfResidence(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
crewManningNumber(optional):
integer
Minimum Length:
0
Maximum Length:38
Example:123
-
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01
-
disembarkDate(optional):
string(date-time)
Example:
2015-09-09
-
disembarkPort(optional):
integer
Example:
123
-
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01
-
documentIssuedCountry(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01
-
emailAddress(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$
Example:EMAIL ADD
-
embarkDate(optional):
string(date-time)
Example:
2015-09-02
-
embarkPort(optional):
integer
Example:
123
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
emergencyContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
gender(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[A-Z]
Example:M or F
-
guestId(optional):
integer
Minimum Value:
0
Example:12345
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Andy
-
nationalIdNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
nationality(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-z0-9]
Example:US
-
onboardStatus(optional):
integer
Example:
0
-
operationalDepartment(optional):
string
Example:
Deck Officer
-
operationalPosition(optional):
string
Example:
1st Engineer
-
passportNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
photo(optional):
string
Example:
/Images/People/
-
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345
-
reservationAccountType(optional):
string
Minimum Length:
1
Maximum Length:1
Allowed Values:[ "P", "R", "C", "V" ]
Pattern:^P|R|C|V$
Example:P
-
reservationBookingNumber(optional):
string
Minimum Length:
1
Maximum Length:100
Pattern:[a-z0-9]
Example:0123456789
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
Example:CC
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:MR
-
title(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Mr
-
travelDocumentNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
unicodeName(optional):
string
Minimum Length:
1
Maximum Length:100
Example:
Nested Schema : guestDetails
Type:
object
Guest information based on the Profile id passed
Show Source
-
accountCategory(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^SYS|GRP|CRW|PAX|VTO$
Example:PAX
-
accountId(optional):
integer
Minimum Value:
1
Example:12345
-
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]
Pattern:^A|P|C|G|V|O$
Example:System Account, Passenger, Crew, Group, Visitor
-
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09
-
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
Example:57
-
alternativeContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
assemblyStationCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-z0-9]
Example:12345
-
assemblyStationName(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
cabinNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:11111
-
classification(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:[VIP]
-
consentStatus(optional):
integer
Example:
0
-
contactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
countryOfBirth(optional):
string
Minimum Length:
1
Maximum Length:3
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
countryOfResidence(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01
-
disembarkDate(optional):
string(date-time)
Example:
2015-09-09
-
disembarkPort(optional):
integer
Example:
123
-
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01
-
documentIssuedCountry(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01
-
emailAddress(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-]+)(\\.([a-zA-Z]{2,5})){1,}$
Example:EMAIL ADD
-
embarkCruiseId(optional):
integer(int32)
Example:
12345
-
embarkDate(optional):
string(date-time)
Example:
2015-09-02
-
embarkPort(optional):
integer
Example:
123
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
emergencyContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
gender(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[A-Z]
Example:M or F
-
groupName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
groupReferenceId(optional):
integer(int32)
Example:
12345
-
guestId(optional):
integer
Minimum Value:
0
Example:12345
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Andy
-
nationalIdNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
nationality(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-z0-9]
Example:US
-
onboardStatus(optional):
integer
Example:
0
-
passportNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
photo(optional):
string
Example:
/Images/People/
-
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345
-
reservationAccountType(optional):
string
Minimum Length:
1
Maximum Length:1
Allowed Values:[ "P", "R", "C", "V" ]
Pattern:^P|R|C|V$
Example:P
-
reservationBookingNumber(optional):
string
Minimum Length:
1
Maximum Length:100
Pattern:[a-z0-9]
Example:0123456789
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationExternalId(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
Example:CC
-
routedAccountNumber(optional):
integer(int32)
Example:
12345
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:MR
-
setSailPass(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:[a-z0-9]
Example:12345
-
title(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Mr
-
travelDocumentNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
unicodeName(optional):
string
Minimum Length:
1
Maximum Length:100
Example:
Nested Schema : residentDetails
Type:
object
Resident information based on the Profile id passed
Show Source
-
accountCategory(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^SYS|GRP|CRW|PAX|VTO$
Example:PAX
-
accountId(optional):
integer
Minimum Value:
1
Example:12345
-
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]
Pattern:^A|P|C|G|V|O$
Example:System Account, Passenger, Crew, Group, Visitor
-
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09
-
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
Example:57
-
alternativeContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
assemblyStationCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-z0-9]
Example:12345
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
cabinNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:11111
-
consentStatus(optional):
integer
Example:
0
-
contactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
countryOfBirth(optional):
string
Minimum Length:
1
Maximum Length:3
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
countryOfResidence(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01
-
disembarkDate(optional):
string(date-time)
Example:
2015-09-09
-
disembarkPort(optional):
integer
Example:
123
-
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01
-
documentIssuedCountry(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01
-
emailAddress(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$
Example:EMAIL ADD
-
embarkCruiseId(optional):
integer(int32)
Example:
12345
-
embarkDate(optional):
string(date-time)
Example:
2015-09-02
-
embarkPort(optional):
integer
Example:
123
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
emergencyContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
gender(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[A-Z]
Example:M or F
-
groupName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
groupReferenceId(optional):
integer(int32)
Example:
12345
-
guestId(optional):
integer
Minimum Value:
0
Example:12345
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Andy
-
nationalIdNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
nationality(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-z0-9]
Example:US
-
onboardStatus(optional):
integer
Example:
0
-
passportNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
photo(optional):
string
Example:
/Images/People/
-
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345
-
reservationAccountType(optional):
string
Minimum Length:
1
Maximum Length:1
Allowed Values:[ "P", "R", "C", "V" ]
Pattern:^P|R|C|V$
Example:P
-
reservationBookingNumber(optional):
string
Minimum Length:
1
Maximum Length:100
Pattern:[a-z0-9]
Example:0123456789
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationExternalId(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
Example:CC
-
routedAccountNumber(optional):
integer(int32)
Example:
12345
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:MR
-
setSailPass(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:[a-z0-9]
Example:12345
-
title(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Mr
-
travelDocumentNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
unicodeName(optional):
string
Minimum Length:
1
Maximum Length:100
Example:
Nested Schema : visitorDetails
Type:
object
Visitor information based on the Profile id passed
Show Source
-
accountId(optional):
integer
Minimum Value:
1
Example:12345
-
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]
Pattern:^A|P|C|G|V|O$
Example:System Account, Passenger, Crew, Group, Visitor
-
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09
-
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
Example:57
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
consentStatus(optional):
integer
Example:
0
-
contactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
countryOfBirth(optional):
string
Minimum Length:
1
Maximum Length:3
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
countryOfResidence(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01
-
disembarkDate(optional):
string(date-time)
Example:
2015-09-09
-
emailAddress(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$
Example:EMAIL ADD
-
embarkDate(optional):
string(date-time)
Example:
2015-09-02
-
embarkPort(optional):
integer
Example:
123
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
emergencyContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
gender(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[A-Z]
Example:M or F
-
groupName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
guestId(optional):
integer
Minimum Value:
0
Example:12345
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Andy
-
nationality(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-z0-9]
Example:US
-
onboardStatus(optional):
integer
Example:
0
-
passportNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
photo(optional):
string
Example:
/Images/People/
-
reservationAccountType(optional):
string
Minimum Length:
1
Maximum Length:1
Allowed Values:[ "P", "R", "C", "V" ]
Pattern:^P|R|C|V$
Example:P
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
Example:CC
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:MR
-
title(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Mr
-
travelDocumentNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
visitorPassType(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:^[a-zA-Z0-9- ]*$
Example:
Nested Schema : linksProfile
Type:
object
links detail
Show Source
-
method(optional):
string
Example:
get
-
rel(optional):
string
Example:
self
Nested Schema : items-allOf[1]
Type:
Show Source
object
-
href(optional):
string
Example:
http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber
-
operationId(optional):
string
Example:
search
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.2",
"title":"Bad Request",
"detail":"Empty request body."
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
You are not authorized to use this API
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
You are forbidden to use this API
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
405 Response
This method is not available
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 Allowed",
"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
The media supplied is not supported
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Invalid content",
"detail":"Content type not supported",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Error occurred while processing this request
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 not available
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