NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve list of guardians associated to a minor
get
/spms/v1/guardians/child/{childId}
This is to retrieve a list of all guardians that associated to a minor
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Returns the list of Guardian IDs
Root Schema : schema
Type:
Show Source
array
-
Array of:
object guardianIdsList
The object returned in Oracle Standard when function is executed successfully
Nested Schema : guardianIdsList
Type:
object
The object returned in Oracle Standard when function is executed successfully
Show Source
Nested Schema : guardianIds
Type:
Show Source
array
-
Array of:
integer
This value is the id value obtained from the guardiansExample:
12345
400 Response
Bad data
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......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
The request has not been applied because it lacks valid authentication credentials for the target resource
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......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
This API is not allowed for the current user
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......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
Not Found
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......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occurred 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......
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1