NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve list of special needs assignments for a profile by profile type
get
/spms/v1/profiles/{profileType}/{accountId}/specialNeeds
This is to retrieve a list of special needs assignments for a profile by profile type
Request
Supported Media Types
- application/json
Path Parameters
-
accountId: integer
-
profileType: string
Allowed Values:
[ "guest", "crew", "resident", "visitor" ]
Response
Supported Media Types
- application/json
200 Response
get successfully
Root Schema : Special Needs
Type:
object
Title:
Special Needs
Special Needs
Show Source
-
code(optional):
array code
-
name(optional):
array name
-
remarks(optional):
string
Example:
Need attention
Nested Schema : code
Type:
array
Example:
[
"WH"
]
Nested Schema : name
Type:
array
Example:
[
"Wheel Chair"
]
403 Response
This API is not allowed for your current user role
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
Invalid parameter(s) passed in
Root Schema : Oracle Response object with singular object returned
Type:
object
Title:
Oracle Response object with singular object returned
The wrapper object when returning successful values in Oracle standard
Show Source
-
item(optional):
array item
A list object that contains error message and field.
Nested Schema : item
Type:
array
A list object that contains error message and field.
Example Response (application/json)
{
"title":"Not Found",
"detail":"Account ID - 106294411 is invalid",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}
405 Response
Method requested not available
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
409 Response
Get Status failed
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occured while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1