Jump to

• Request
• Response

Update a managed student group

patch

/fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• GroupDescription: string
  Title: Description

  Maximum Length: 1000

  Description of the managed student group.
• GroupName(required): string
  Title: Proxy Group Name

  Maximum Length: 100

  Unique name of 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.
• OwnerPartyId(required): 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.

{
    "required":[
        "GroupName",
        "OwnerPartyId"
    ],
    "type":"object",
    "properties":{
        "GroupName":{
            "title":"Proxy Group Name",
            "maxLength":"100",
            "type":"string",
            "description":"Unique name of the managed student group.",
            "nullable":false
        },
        "GroupDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the managed student group.",
            "nullable":true
        },
        "proxies":{
            "title":"Group Managers",
            "type":"array",
            "description":"The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-proxies-item-patch-request"
            }
        },
        "OwnerPartyId":{
            "title":"Owner Party ID",
            "type":"integer",
            "description":"The unique identifier for the party that created the managed student group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "learners":{
            "title":"Students",
            "type":"array",
            "description":"The students resource is a child of the managed student groups resource and provides the list of associated student members.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-learners-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Students",
    "type":"array",
    "description":"The students resource is a child of the managed student groups resource and provides the list of associated student members.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-learners-item-patch-request"
    }
}

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

• Array of: object hedProxyGroups-proxies-item-patch-request

{
    "title":"Group Managers",
    "type":"array",
    "description":"The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-proxies-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• learnerImages: array User Images
  Title: User Images

  User images provide the images of a user.

{
    "type":"object",
    "properties":{
        "learnerImages":{
            "title":"User Images",
            "type":"array",
            "description":"User images provide the images of a user.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-learners-learnerImages-item-patch-request"
            }
        }
    }
}

Nested Schema : User Images

Type: array

Title: User Images

User images provide the images of a user.

Show Source

• Array of: object hedProxyGroups-learners-learnerImages-item-patch-request

{
    "title":"User Images",
    "type":"array",
    "description":"User images provide the images of a user.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-learners-learnerImages-item-patch-request"
    }
}

Nested Schema : hedProxyGroups-learners-learnerImages-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : hedProxyGroups-proxies-item-patch-request

Type: object

Show Source

• proxyImages: array User Images
  Title: User Images

  User images provide the images of a user.

{
    "type":"object",
    "properties":{
        "proxyImages":{
            "title":"User Images",
            "type":"array",
            "description":"User images provide the images of a user.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-proxies-proxyImages-item-patch-request"
            }
        }
    }
}

Nested Schema : User Images

Type: array

Title: User Images

User images provide the images of a user.

Show Source

• Array of: object hedProxyGroups-proxies-proxyImages-item-patch-request

{
    "title":"User Images",
    "type":"array",
    "description":"User images provide the images of a user.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-proxies-proxyImages-item-patch-request"
    }
}

Nested Schema : hedProxyGroups-proxies-proxyImages-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedProxyGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the managed student group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupName":{
            "title":"Proxy Group Name",
            "maxLength":"100",
            "type":"string",
            "description":"Unique name of the managed student group.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the managed student group.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the managed student group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Proxy Group Owner Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party that created the managed student group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the managed student group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyId":{
            "title":"Owner Party ID",
            "type":"integer",
            "description":"The unique identifier for the party that created the managed student group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "learners":{
            "title":"Students",
            "type":"array",
            "description":"The students resource is a child of the managed student groups resource and provides the list of associated student members.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-learners-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "proxies":{
            "title":"Group Managers",
            "type":"array",
            "description":"The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-proxies-item-response"
            }
        },
        "GroupId":{
            "title":"Group ID",
            "type":"integer",
            "description":"The unique identifier for a managed student group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the managed student group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object hedProxyGroups-learners-item-response

{
    "title":"Students",
    "type":"array",
    "description":"The students resource is a child of the managed student groups resource and provides the list of associated student members.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-learners-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object hedProxyGroups-proxies-item-response

{
    "title":"Group Managers",
    "type":"array",
    "description":"The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-proxies-item-response"
    }
}

Nested Schema : hedProxyGroups-learners-item-response

Type: object

Show Source

• 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 User Images
  Title: User Images

  User images provide the images of a user.
• 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.

{
    "type":"object",
    "properties":{
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"Date of birth of the student member.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the student member was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the student member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the student member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "type":"string",
            "description":"User name of the student member.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the student member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "LearnerMemberId":{
            "title":"Learner Member ID",
            "type":"integer",
            "description":"The unique identifier for the student member in a managed student group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LearnerPartyId":{
            "title":"Learner Party ID",
            "type":"integer",
            "description":"Unique identifier for the student member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"Middle name of the student member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"Email address of the student member.",
            "nullable":true,
            "x-queryable":true
        },
        "MembershipStatusCode":{
            "title":"Membership Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Current status code of the student member.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HEY_PENDING",
            "x-queryable":true
        },
        "learnerImages":{
            "title":"User Images",
            "type":"array",
            "description":"User images provide the images of a user.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-learners-learnerImages-item-response"
            }
        },
        "MembershipStatusMeaning":{
            "title":"Membership Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the status code of the student member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"Full name of the student member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "type":"string",
            "description":"Last name of the student member.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the student member.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : User Images

Type: array

Title: User Images

User images provide the images of a user.

Show Source

• Array of: object hedProxyGroups-learners-learnerImages-item-response

{
    "title":"User Images",
    "type":"array",
    "description":"User images provide the images of a user.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-learners-learnerImages-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedProxyGroups-learners-learnerImages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The unique identifier for the image.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageTypeCode":{
            "title":"Attachment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the attachment, defaulted to PROFILE_PHOTO.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The binary representation of the attachment.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedProxyGroups-proxies-item-response

Type: object

Show Source

• 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 date when the group manager member was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the group manager member.
• 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 User Images
  Title: User Images

  User images provide the images of a user.
• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the group manager member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the group manager member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProxyMemberId":{
            "title":"Proxy Member ID",
            "type":"integer",
            "description":"The unique identifier for the group manager member in a managed student group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the group manager member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "type":"string",
            "description":"User name of the group manager member.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the group manager member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "proxyImages":{
            "title":"User Images",
            "type":"array",
            "description":"User images provide the images of a user.",
            "items":{
                "$ref":"#/components/schemas/hedProxyGroups-proxies-proxyImages-item-response"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"Middle name of the group manager member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"Email address of the group manager member.",
            "nullable":true,
            "x-queryable":true
        },
        "MembershipStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Current status code of the group manager member.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HEY_PENDING",
            "x-queryable":true
        },
        "MembershipStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the status code of the group manager member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"Full name of the group manager member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProxyPartyId":{
            "title":"Proxy Party ID",
            "type":"integer",
            "description":"Unique identifier for the group manager member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "type":"string",
            "description":"Last name of the group manager member.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the group manager member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : User Images

Type: array

Title: User Images

User images provide the images of a user.

Show Source

• Array of: object hedProxyGroups-proxies-proxyImages-item-response

{
    "title":"User Images",
    "type":"array",
    "description":"User images provide the images of a user.",
    "items":{
        "$ref":"#/components/schemas/hedProxyGroups-proxies-proxyImages-item-response"
    }
}

Nested Schema : hedProxyGroups-proxies-proxyImages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The unique identifier for the image.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageTypeCode":{
            "title":"Attachment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the attachment, defaulted to PROFILE_PHOTO.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The binary representation of the attachment.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

learners

Operation: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/learners

Parameters:

• GroupId: $request.path.GroupId

The students resource is a child of the managed student groups resource and provides the list of associated student members.

proxies

Operation: /fscmRestApi/resources/11.13.18.05/hedProxyGroups/{GroupId}/child/proxies

Parameters:

• GroupId: $request.path.GroupId

The group managers resource is a child of the managed student groups resource and provides the list of associated group manager members.

Back to Top