Create a student member belonging to a managed student group
post
/fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners
Request
Path Parameters
-
GroupId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EmailAddress: string
Title:
Email
Email address of the student member. -
LastName: string
Title:
Last Name
Last name of the student member. -
learnerImages: array
Student Images
Title:
Student Images
The student images resource provides the images of a student. -
LearnerPartyId(required): integer
(int64)
Title:
Learner Party ID
Unique identifier for the student member. -
UserName: string
Title:
User Name
User name of the student member.
Nested Schema : Student Images
Type:
array
Title:
Student Images
The student images resource provides the images of a student.
Show Source
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hedProxyGroups-learners-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the student member. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the student member was created. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
Date of birth of the student member. -
EmailAddress: string
Title:
Email
Email address of the student member. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
First name of the student member. -
FullName: string
Title:
Full Name
Read Only:true
Maximum Length:360
Full name of the student member. -
LastName: string
Title:
Last Name
Last name of the student member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the student member. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the student member was last updated. -
learnerImages: array
Student Images
Title:
Student Images
The student images resource provides the images of a student. -
LearnerMemberId: integer
(int64)
Title:
Learner Member ID
Read Only:true
The unique identifier for the student member in a managed student group. -
LearnerPartyId: integer
(int64)
Title:
Learner Party ID
Unique identifier for the student member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MembershipStatusCode: string
Title:
Membership Status Code
Read Only:true
Maximum Length:30
Default Value:ORA_HEY_PENDING
Current status code of the student member. -
MembershipStatusMeaning: string
Title:
Membership Status
Read Only:true
Maximum Length:80
Meaning of the status code of the student member. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
Middle name of the student member. -
UserName: string
Title:
User Name
User name of the student member.
Nested Schema : Student Images
Type:
array
Title:
Student Images
The student images resource provides the images of a student.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedProxyGroups-learners-learnerImages-item-response
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
Read Only:true
The binary representation of the attachment. -
ImageId: integer
(int64)
Title:
Attachment ID
Read Only:true
The unique identifier for the image. -
ImageTypeCode: string
Title:
Attachment Type Code
Read Only:true
Maximum Length:30
The type code of the attachment, defaulted to PROFILE_PHOTO. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- learnerImages
-
Parameters:
- GroupId:
$request.path.GroupId
- LearnerMemberId:
$request.path.LearnerMemberId
The student images resource provides the images of a student. - GroupId:
- sendReminder
-
Parameters:
- GroupId:
$request.path.GroupId
- LearnerMemberId:
$request.path.LearnerMemberId
Sends a reminder communication to the student member requesting for approval to join the managed student group. - GroupId: