Jump to

• Request
• Response

Update an academic history

patch

/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories/{academicHistoriesUniqID}

Request

Path Parameters

• ApplicationId(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=
• academicHistoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Academic Histories resource and used to uniquely identify an instance of Academic Histories. The client should not generate the hash key value. Instead, the client should query on the Academic Histories collection resource in order to navigate to a specific instance of Academic Histories to get the hash key.

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

• AcademicLevelCode: string
  Title: Academic Level Code

  Maximum Length: 30

  Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level.
• ClassRankPosition: integer (int32)
  Title: Class Rank Position

  Rank position of the student in the class.
• ClassRankSize: integer (int32)
  Title: Class Rank Size

  Size of the class in which the student had a rank.
• ContactAddress: string
  Title: Contact Address

  Maximum Length: 1000

  Location address of the external contact associated with an academic history.
• ContactEmailAddress: string
  Title: Contact Email Address

  Maximum Length: 1000

  Email address of the external contact associated with an academic history.
• ContactFirstName: string
  Title: Contact First Name

  Maximum Length: 150

  First name of the external contact associated with an academic history.
• ContactLastName: string
  Title: Contact Last Name

  Maximum Length: 150

  Last name of the external contact associated with an academic history.
• ContactNameTitle: string
  Title: Contact Title

  Maximum Length: 100

  Title of external contact, such as counselor.
• ContactPartyId: integer (int64)
  Title: Contact Party ID

  Trading community party identifier for the contact.
• DegreeCode: string
  Title: Degree Code

  Maximum Length: 30

  Code of the degree or qualification which the student earned.
• DegreeEarned: string
  Title: Degree Earned

  Maximum Length: 200

  Degree or qualification which the student earned.
• EntryDate: string (date)
  Title: Entry Date

  Date the student was admitted to the external organization.
• GPA: number
  Title: GPA

  School grade point average of the student.
• GPAWeightingCode: string
  Title: GPA Weighting

  Maximum Length: 30

  Code for the weighting used to calculate the school grade point average of the student.
• GraduationDate: string (date)
  Title: Graduation Date

  The date the student graduated from the external organization.
• GraduationFlag: boolean
  Title: Graduation Indicator

  Maximum Length: 1

  Indicates whether the student graduated from the external organization.
• HomeSchoolFlag: boolean
  Title: Home School Indicator

  Maximum Length: 1

  Indicates whether the student has been home schooled.
• MajorProgramCode: string
  Title: Major Program Code

  Maximum Length: 30

  Major or program which the student earned a degree from.
• OrganizationOtherName: string
  Title: Other External Organization Name

  Maximum Length: 200

  Trading community party name of the external organization name entered by the student.
• OrganizationOtherNameFlag: boolean
  Title: Other External Organization Name Indicator

  Maximum Length: 1

  Indicates whether an external organization name was entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database.
• OrganizationPartyId: integer (int64)
  Title: External Organization Party ID

  Trading community party identifier for the external organization associated with an academic history.
• OrganizationTypeCode: string
  Title: External Organization Type Code

  Maximum Length: 30

  External organization type, for example secondary school.
• PhoneAreaCode: string
  Title: Contact Phone Area Code

  Maximum Length: 10

  Phone area code of the external contact associated with an academic history.
• PhoneCountryCode: string
  Title: Contact Phone Country Code

  Maximum Length: 10

  Phone country code of the external contact associated with an academic history.
• PhoneNumber: string
  Title: Contact Phone Number

  Maximum Length: 40

  Phone contact number of the external contact associated with an academic history.
• ReducedPriceMealFlag: boolean
  Title: Free or Reduced Price Meal Indicator

  Maximum Length: 1

  Indicates whether the student qualified for free or reduced price meals at school.
• StudentIdentifier: string
  Title: Student ID

  Maximum Length: 50

  Identifier assigned to the student by the organization.

{
    "type":"object",
    "properties":{
        "OrganizationOtherName":{
            "title":"Other External Organization Name",
            "maxLength":200,
            "type":"string",
            "description":"Trading community party name of the external organization name entered by the student.",
            "nullable":true
        },
        "OrganizationPartyId":{
            "title":"External Organization Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization associated with an academic history.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "OrganizationTypeCode":{
            "title":"External Organization Type Code",
            "maxLength":30,
            "type":"string",
            "description":"External organization type, for example secondary school.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GraduationFlag":{
            "title":"Graduation Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the student graduated from the external organization.",
            "nullable":true
        },
        "ContactNameTitle":{
            "title":"Contact Title",
            "maxLength":100,
            "type":"string",
            "description":"Title of external contact, such as counselor.",
            "nullable":true
        },
        "GPAWeightingCode":{
            "title":"GPA Weighting",
            "maxLength":30,
            "type":"string",
            "description":"Code for the weighting used to calculate the school grade point average of the student.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReducedPriceMealFlag":{
            "title":"Free or Reduced Price Meal Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the student qualified for free or reduced price meals at school.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "title":"Contact Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Phone country code of the external contact associated with an academic history.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneAreaCode":{
            "title":"Contact Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"Phone area code of the external contact associated with an academic history.",
            "nullable":true
        },
        "GraduationDate":{
            "title":"Graduation Date",
            "type":"string",
            "description":"The date the student graduated from the external organization.",
            "format":"date",
            "nullable":true
        },
        "DegreeCode":{
            "title":"Degree Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the degree or qualification which the student earned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MajorProgramCode":{
            "title":"Major Program Code",
            "maxLength":30,
            "type":"string",
            "description":"Major or program which the student earned a degree from.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactFirstName":{
            "title":"Contact First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the external contact associated with an academic history.",
            "nullable":true
        },
        "ContactAddress":{
            "title":"Contact Address",
            "maxLength":1000,
            "type":"string",
            "description":"Location address of the external contact associated with an academic history.",
            "nullable":true
        },
        "AcademicLevelCode":{
            "title":"Academic Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DegreeEarned":{
            "title":"Degree Earned",
            "maxLength":200,
            "type":"string",
            "description":"Degree or qualification which the student earned.",
            "nullable":true
        },
        "OrganizationOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an external organization name was entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database.",
            "nullable":true
        },
        "ClassRankPosition":{
            "title":"Class Rank Position",
            "type":"integer",
            "description":"Rank position of the student in the class.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            }
        },
        "ContactLastName":{
            "title":"Contact Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the external contact associated with an academic history.",
            "nullable":true
        },
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":1000,
            "type":"string",
            "description":"Email address of the external contact associated with an academic history.",
            "nullable":true
        },
        "StudentIdentifier":{
            "title":"Student ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifier assigned to the student by the organization.",
            "nullable":true
        },
        "EntryDate":{
            "title":"Entry Date",
            "type":"string",
            "description":"Date the student was admitted to the external organization.",
            "format":"date",
            "nullable":true
        },
        "ClassRankSize":{
            "title":"Class Rank Size",
            "type":"integer",
            "description":"Size of the class in which the student had a rank.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            }
        },
        "GPA":{
            "title":"GPA",
            "type":"number",
            "description":"School grade point average of the student.",
            "nullable":true,
            "x-hints":{
                "precision":3,
                "scale":2
            }
        },
        "PhoneNumber":{
            "title":"Contact Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"Phone contact number of the external contact associated with an academic history.",
            "nullable":true
        },
        "HomeSchoolFlag":{
            "title":"Home School Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the student has been home schooled.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : admissionApplications-academicHistories-item-response

Type: object

Show Source

• AcademicHistoryTransactionId: integer (int64)
  Title: Academic History Transaction ID

  Read Only: true

  Academic history transaction unique identifier.
• AcademicLevelCode: string
  Title: Academic Level Code

  Maximum Length: 30

  Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level.
• AcademicLevelCodeMeaning: string
  Title: Academic Level

  Read Only: true

  Maximum Length: 80

  Meaning of academic level code.
• ClassRankPosition: integer (int32)
  Title: Class Rank Position

  Rank position of the student in the class.
• ClassRankSize: integer (int32)
  Title: Class Rank Size

  Size of the class in which the student had a rank.
• ContactAddress: string
  Title: Contact Address

  Maximum Length: 1000

  Location address of the external contact associated with an academic history.
• ContactEmailAddress: string
  Title: Contact Email Address

  Maximum Length: 1000

  Email address of the external contact associated with an academic history.
• ContactFirstName: string
  Title: Contact First Name

  Maximum Length: 150

  First name of the external contact associated with an academic history.
• ContactLastName: string
  Title: Contact Last Name

  Maximum Length: 150

  Last name of the external contact associated with an academic history.
• ContactNameTitle: string
  Title: Contact Title

  Maximum Length: 100

  Title of external contact, such as counselor.
• ContactPartyId: integer (int64)
  Title: Contact Party ID

  Trading community party identifier for the contact.
• DegreeCode: string
  Title: Degree Code

  Maximum Length: 30

  Code of the degree or qualification which the student earned.
• DegreeCodeMeaning: string
  Title: Degree

  Read Only: true

  Maximum Length: 80

  Meaning of degree code.
• DegreeEarned: string
  Title: Degree Earned

  Maximum Length: 200

  Degree or qualification which the student earned.
• EntryDate: string (date)
  Title: Entry Date

  Date the student was admitted to the external organization.
• GPA: number
  Title: GPA

  School grade point average of the student.
• GPAWeightingCode: string
  Title: GPA Weighting

  Maximum Length: 30

  Code for the weighting used to calculate the school grade point average of the student.
• GPAWeightingMeaning: string
  Title: GPA Weighting

  Read Only: true

  Maximum Length: 80

  Meaning of the GPA weighting code.
• GraduationDate: string (date)
  Title: Graduation Date

  The date the student graduated from the external organization.
• GraduationFlag: boolean
  Title: Graduation Indicator

  Maximum Length: 1

  Indicates whether the student graduated from the external organization.
• HomeSchoolFlag: boolean
  Title: Home School Indicator

  Maximum Length: 1

  Indicates whether the student has been home schooled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorProgramCode: string
  Title: Major Program Code

  Maximum Length: 30

  Major or program which the student earned a degree from.
• MajorProgramCodeMeaning: string
  Title: Major Program

  Read Only: true

  Maximum Length: 80

  Meaning of the major program code.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 100

  Name of the external organization associated with the academic history.
• OrganizationOtherName: string
  Title: Other External Organization Name

  Maximum Length: 200

  Trading community party name of the external organization name entered by the student.
• OrganizationOtherNameFlag: boolean
  Title: Other External Organization Name Indicator

  Maximum Length: 1

  Indicates whether an external organization name was entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database.
• OrganizationPartyId: integer (int64)
  Title: External Organization Party ID

  Trading community party identifier for the external organization associated with an academic history.
• OrganizationTypeCode: string
  Title: External Organization Type Code

  Maximum Length: 30

  External organization type, for example secondary school.
• OrganizationTypeCodeMeaning: string
  Title: External Organization Type

  Read Only: true

  Maximum Length: 80

  Meaning of organization type code.
• PhoneAreaCode: string
  Title: Contact Phone Area Code

  Maximum Length: 10

  Phone area code of the external contact associated with an academic history.
• PhoneCountryCode: string
  Title: Contact Phone Country Code

  Maximum Length: 10

  Phone country code of the external contact associated with an academic history.
• PhoneNumber: string
  Title: Contact Phone Number

  Maximum Length: 40

  Phone contact number of the external contact associated with an academic history.
• ReducedPriceMealFlag: boolean
  Title: Free or Reduced Price Meal Indicator

  Maximum Length: 1

  Indicates whether the student qualified for free or reduced price meals at school.
• StudentIdentifier: string
  Title: Student ID

  Maximum Length: 50

  Identifier assigned to the student by the organization.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the external organization associated with the academic history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationOtherName":{
            "title":"Other External Organization Name",
            "maxLength":200,
            "type":"string",
            "description":"Trading community party name of the external organization name entered by the student.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationPartyId":{
            "title":"External Organization Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization associated with an academic history.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"External Organization Type Code",
            "maxLength":30,
            "type":"string",
            "description":"External organization type, for example secondary school.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicHistoryTransactionId":{
            "title":"Academic History Transaction ID",
            "type":"integer",
            "description":"Academic history transaction unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MajorProgramCodeMeaning":{
            "title":"Major Program",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the major program code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GraduationFlag":{
            "title":"Graduation Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the student graduated from the external organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameTitle":{
            "title":"Contact Title",
            "maxLength":100,
            "type":"string",
            "description":"Title of external contact, such as counselor.",
            "nullable":true,
            "x-queryable":true
        },
        "GPAWeightingCode":{
            "title":"GPA Weighting",
            "maxLength":30,
            "type":"string",
            "description":"Code for the weighting used to calculate the school grade point average of the student.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReducedPriceMealFlag":{
            "title":"Free or Reduced Price Meal Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the student qualified for free or reduced price meals at school.",
            "nullable":true,
            "x-queryable":true
        },
        "GPAWeightingMeaning":{
            "title":"GPA Weighting",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the GPA weighting code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Contact Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Phone country code of the external contact associated with an academic history.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Contact Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"Phone area code of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "GraduationDate":{
            "title":"Graduation Date",
            "type":"string",
            "description":"The date the student graduated from the external organization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DegreeCode":{
            "title":"Degree Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the degree or qualification which the student earned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationTypeCodeMeaning":{
            "title":"External Organization Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of organization type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorProgramCode":{
            "title":"Major Program Code",
            "maxLength":30,
            "type":"string",
            "description":"Major or program which the student earned a degree from.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactFirstName":{
            "title":"Contact First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress":{
            "title":"Contact Address",
            "maxLength":1000,
            "type":"string",
            "description":"Location address of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicLevelCode":{
            "title":"Academic Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DegreeCodeMeaning":{
            "title":"Degree",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of degree code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelCodeMeaning":{
            "title":"Academic Level",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of academic level code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DegreeEarned":{
            "title":"Degree Earned",
            "maxLength":200,
            "type":"string",
            "description":"Degree or qualification which the student earned.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an external organization name was entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassRankPosition":{
            "title":"Class Rank Position",
            "type":"integer",
            "description":"Rank position of the student in the class.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Contact Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":1000,
            "type":"string",
            "description":"Email address of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "StudentIdentifier":{
            "title":"Student ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifier assigned to the student by the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "EntryDate":{
            "title":"Entry Date",
            "type":"string",
            "description":"Date the student was admitted to the external organization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassRankSize":{
            "title":"Class Rank Size",
            "type":"integer",
            "description":"Size of the class in which the student had a rank.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "GPA":{
            "title":"GPA",
            "type":"number",
            "description":"School grade point average of the student.",
            "nullable":true,
            "x-hints":{
                "precision":3,
                "scale":2
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Contact Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"Phone contact number of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeSchoolFlag":{
            "title":"Home School Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the student has been home schooled.",
            "nullable":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 : 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

GPAWeightingCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_GPA_WEIGHTING%2CLookupCode%3D{GPAWeightingCode}

The following properties are defined on the LOV link relation:

• Source Attribute: GPAWeightingCode; Target Attribute: LookupCode
• Display Attribute: Meaning

academicLevelCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_ACAD_LEVEL%2CLookupCode%3D{AcademicLevelCode}

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicLevelCode; Target Attribute: LookupCode
• Display Attribute: Meaning

degreeCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_DEGREE%2CLookupCode%3D{DegreeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: DegreeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

majorProgramCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_MAJOR_PROG%2CLookupCode%3D{MajorProgramCode}

The following properties are defined on the LOV link relation:

• Source Attribute: MajorProgramCode; Target Attribute: LookupCode
• Display Attribute: Meaning

organizationTypeCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_ORG_TYPE%2CLookupCode%3D{OrganizationTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: OrganizationTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

organizationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: OrganizationPartyId; Target Attribute: PartyId
• Display Attribute: OrganizationName

phoneCountryCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedPhoneCountryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

Back to Top