Get all managed student groups
get
/fscmRestApi/resources/11.13.18.05/hedProxyGroups
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- ByKeywordFinder Finds the managed student group that matches the specified keyword.
Finder Variables- Keyword; string; The keyword for the managed student group.
- PrimaryKey Finds the managed student group that matches the primary key criteria specified.
Finder Variables- GroupId; integer; The unique identifier for the managed student group.
- ByKeywordFinder Finds the managed student group that matches the specified keyword.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the managed student group.
- CreationDate; string; The date when the managed student group was created.
- GroupDescription; string; Description of the managed student group.
- GroupId; integer; The unique identifier for a managed student group.
- GroupName; string; Unique name of the managed student group.
- LastUpdateDate; string; The date when the managed student group was last updated.
- LastUpdatedBy; string; The user who last updated the managed student group.
- OwnerName; string; Name of the party that created the managed student group.
- OwnerPartyId; integer; The unique identifier for the party that created the managed student group.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedProxyGroups-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the managed student group. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the managed student group was created. -
GroupDescription: string
Title:
Description
Maximum Length:1000
Description of the managed student group. -
GroupId: integer
(int64)
Title:
Group ID
Read Only:true
The unique identifier for a managed student group. -
GroupName: string
Title:
Proxy Group Name
Maximum Length:100
Unique name of the managed student group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the managed student group was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the managed student group. -
learners: array
Students
Title:
Students
The students resource is a child of the managed student groups resource and provides the list of associated student members. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerName: string
Title:
Proxy Group Owner Name
Read Only:true
Maximum Length:360
Name of the party that created the managed student group. -
OwnerPartyId: integer
(int64)
Title:
Owner Party ID
The unique identifier for the party that created the managed student group. -
proxies: array
Group Managers
Title:
Group Managers
The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.
Nested Schema : Students
Type:
array
Title:
Students
The students resource is a child of the managed student groups resource and provides the list of associated student members.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Group Managers
Type:
array
Title:
Group Managers
The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.
Show Source
Nested 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.
Nested Schema : hedProxyGroups-proxies-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the group manager member. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the group manager member was created. -
EmailAddress: string
Title:
Email
Email address of the group manager member. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
First name of the group manager member. -
FullName: string
Title:
Full Name
Read Only:true
Maximum Length:360
Full name of the group manager member. -
LastName: string
Title:
Last Name
Last name of the group manager member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the group manager member. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the group manager member was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MembershipStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_HEY_PENDING
Current status code of the group manager member. -
MembershipStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the status code of the group manager member. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
Middle name of the group manager member. -
proxyImages: array
Student Images
Title:
Student Images
The student images resource provides the images of a student. -
ProxyMemberId: integer
(int64)
Title:
Proxy Member ID
Read Only:true
The unique identifier for the group manager member in a managed student group. -
ProxyPartyId: integer
(int64)
Title:
Proxy Party ID
Unique identifier for the group manager member. -
UserName: string
Title:
User Name
User name of the group manager member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Student Images
Type:
array
Title:
Student Images
The student images resource provides the images of a student.
Show Source
Nested Schema : hedProxyGroups-proxies-proxyImages-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