Jump to

• Request
• Response

Create a managed student group's member relationship request

post

/fscmRestApi/resources/11.13.18.05/hedProxyGroupMemberRequests/{MemberId}/child/relationshipRequests

Request

Path Parameters

• MemberId(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: string
  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: string
  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

• ObjectMemberId: integer (int64)
  Unique identifier of a member in the managed student group.
• RelationshipCode: string
  Maximum Length: 30

  The code of the relationship with the group member.
• RelationshipTypeCode: string
  Maximum Length: 30

  The type code of the relationship with the group member.

{
    "type":"object",
    "properties":{
        "ObjectMemberId":{
            "type":"integer",
            "description":"Unique identifier of a member in the managed student group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the relationship with the group member.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type code of the relationship with the group member.",
            "nullable":false
        }
    }
}

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 : hedProxyGroupMemberRequests-relationshipRequests-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectMemberEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Email address of the person related to the group member.
• ObjectMemberFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of the person related to the group member.
• ObjectMemberFullName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Full name of the person related to the group member.
• ObjectMemberId: integer (int64)
  Unique identifier of a member in the managed student group.
• ObjectMemberLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the person related to the group member.
• ObjectMemberMiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  Middle name of the person related to the group member.
• RelationshipCode: string
  Maximum Length: 30

  The code of the relationship with the group member.
• RelationshipMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the relationship code.
• RelationshipRequestId: integer (int64)
  Read Only: true

  Unique identifier of a relationship request for a member in the managed student group.
• RelationshipTypeCode: string
  Maximum Length: 30

  The type code of the relationship with the group member.
• RelationshipTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the relationship type code.

{
    "type":"object",
    "properties":{
        "ObjectMemberEmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"Email address of the person related to the group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ObjectMemberFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the person related to the group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "ObjectMemberFullName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Full name of the person related to the group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectMemberId":{
            "type":"integer",
            "description":"Unique identifier of a member in the managed student group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectMemberLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person related to the group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "ObjectMemberMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the person related to the group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the relationship with the group member.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the relationship code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipRequestId":{
            "type":"integer",
            "description":"Unique identifier of a relationship request for a member in the managed student group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type code of the relationship with the group member.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the relationship type code.",
            "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"
            }
        }
    }
}

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."
        }
    }
}

Links

relationshipCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedRelationshipTypesLOV

Parameters:

• finder: PersonRelationshipTypeFinder%3BInUseRelationshipTypeCode%3D{RelationshipTypeCode}%2CInUseRelationshipCode%3D{RelationshipCode}

The following properties are defined on the LOV link relation:

• Source Attribute: RelationshipCode; Target Attribute: RelationshipCode
• Display Attribute: RelationshipMeaning

Back to Top