Jump to

• Request
• Response

Update a student credit assignment

patch

/fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}

Request

Path Parameters

• CreditAssignmentId(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

• AllCurriculumFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the curriculum is derived from the sponsorship credit or from the academic period. If the value is true, the curriculum list comes from the sponsorship credit.
• Amount: number
  The amount of the student credit assignment.
• AmountTypeCode: string
  Maximum Length: 255

  The unique code of the amount type.
• AssignmentStatusCode: string
  Maximum Length: 30

  The unique code of the status of the student credit assignment.
• creditCurriculums: array Credit Curriculums
  Title: Credit Curriculums

  The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.
• EligibilityEndDate: string (date)
  The date when the eligibility for waiver by amount ends.
• MaximumAmount: number
  Maximum amount of the credit.
• OverrideAmountFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the student credit assignment overrides existing setup. If the value is true, the credit attributes will override the default setup.

{
    "type":"object",
    "properties":{
        "OverrideAmountFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the student credit assignment overrides existing setup. If the value is true, the credit attributes will override the default setup.",
            "nullable":true,
            "default":false
        },
        "AmountTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique code of the amount type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the student credit assignment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "MaximumAmount":{
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "EligibilityEndDate":{
            "type":"string",
            "description":"The date when the eligibility for waiver by amount ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "AssignmentStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique code of the status of the student credit assignment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "creditCurriculums":{
            "title":"Credit Curriculums",
            "type":"array",
            "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditAssignments-creditCurriculums-item-patch-request"
            }
        },
        "AllCurriculumFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the curriculum is derived from the sponsorship credit or from the academic period. If the value is true, the curriculum list comes from the sponsorship credit.",
            "nullable":false,
            "default":false
        }
    }
}

Nested Schema : Credit Curriculums

Type: array

Title: Credit Curriculums

The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.

Show Source

• Array of: object studentCreditAssignments-creditCurriculums-item-patch-request

{
    "title":"Credit Curriculums",
    "type":"array",
    "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditAssignments-creditCurriculums-item-patch-request"
    }
}

Nested Schema : studentCreditAssignments-creditCurriculums-item-patch-request

Type: object

Show Source

• CurriculumId: integer (int64)
  Unique identifier of the curriculum.
• StatusCode: string
  Maximum Length: 30

  Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.

{
    "type":"object",
    "properties":{
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurriculumId":{
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

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 : studentCreditAssignments-item-response

Type: object

Show Source

• AcademicPeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the academic period ends.
• AcademicPeriodId: integer (int64)
  Read Only: true

  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  Name of the academic period.
• AcademicPeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the academic period starts.
• AllCurriculumFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the curriculum is derived from the sponsorship credit or from the academic period. If the value is true, the curriculum list comes from the sponsorship credit.
• Amount: number
  The amount of the student credit assignment.
• AmountTypeCode: string
  Maximum Length: 255

  The unique code of the amount type.
• AmountTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The name of the amount type.
• AssignmentStatusCode: string
  Maximum Length: 30

  The unique code of the status of the student credit assignment.
• AssignmentStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The name of the status of the student credit assignment.
• CreationDate: string (date-time)
  Read Only: true

  Date when the transaction was created.
• CreditAssignmentId: integer (int64)
  Read Only: true

  The unique identifier of the student credit assignment.
• CreditCode: string
  Maximum Length: 30

  The unique code to identify the student credit.
• creditCurriculums: array Credit Curriculums
  Title: Credit Curriculums

  The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.
• CreditId: integer (int64)
  The unique identifier of the student credit.
• CreditName: string
  Read Only: true

  Maximum Length: 50

  The name of the student credit.
• CreditPeriodDescription: string
  Read Only: true

  Maximum Length: 240

  The description of the student credit period.
• CreditPeriodId: integer (int64)
  The unique identifier of the student credit period.
• CreditTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code of the credit type.
• CreditTypeId: integer (int64)
  Read Only: true

  Unique identifier of the credit type.
• CreditTypeName: string
  Read Only: true

  Maximum Length: 50

  Name of the credit type. It can be external funds, waivers, and so on.
• CustomerAccountNumber: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the student's customer account.
• EligibilityEndDate: string (date)
  The date when the eligibility for waiver by amount ends.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the transaction was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAmount: number
  Maximum amount of the credit.
• OverrideAmountFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the student credit assignment overrides existing setup. If the value is true, the credit attributes will override the default setup.
• StudentEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The primary email address of the student.
• StudentPartyId: integer (int64)
  Unique identifier of the student.
• StudentPartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the student.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique code to identify the student credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditTypeId":{
            "type":"integer",
            "description":"Unique identifier of the credit type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumAmount":{
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "AcademicPeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the academic period starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StudentEmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The primary email address of the student.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "CreditPeriodDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"The description of the student credit period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier of the student credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StudentPartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the student.",
            "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"
            }
        },
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the student credit period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of the student credit assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "creditCurriculums":{
            "title":"Credit Curriculums",
            "type":"array",
            "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditAssignments-creditCurriculums-item-response"
            }
        },
        "AssignmentStatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the status of the student credit assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the academic period ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideAmountFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the student credit assignment overrides existing setup. If the value is true, the credit attributes will override the default setup.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CreditTypeName":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of the credit type. It can be external funds, waivers, and so on.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique code of the amount type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the student credit assignment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "CreditName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the student credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StudentPartyId":{
            "type":"integer",
            "description":"Unique identifier of the student.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the student's customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllCurriculumFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the curriculum is derived from the sponsorship credit or from the academic period. If the value is true, the curriculum list comes from the sponsorship credit.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the credit type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibilityEndDate":{
            "type":"string",
            "description":"The date when the eligibility for waiver by amount ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "AssignmentStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique code of the status of the student credit assignment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the amount type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Credit Curriculums

Type: array

Title: Credit Curriculums

The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.

Show Source

• Array of: object studentCreditAssignments-creditCurriculums-item-response

{
    "title":"Credit Curriculums",
    "type":"array",
    "description":"The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditAssignments-creditCurriculums-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 : studentCreditAssignments-creditCurriculums-item-response

Type: object

Show Source

• CreditCurriculumId: integer (int64)
  Unique identifier of the curriculum assigned to the student for a particular credit.
• CurriculumId: integer (int64)
  Unique identifier of the curriculum.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  Name of the curriculum.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  Full description of the curriculum type.
• CurriculumTypeId: string
  Read Only: true

  Unique identifier of the type associated with the curriculum. It can be course, scheduled course, program, or course list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusCode: string
  Maximum Length: 30

  Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Full description of the student's curriculum assignment status for a particular credit.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Full description of the student's curriculum assignment status for a particular credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "type":"string",
            "description":"Unique identifier of the type associated with the curriculum. It can be course, scheduled course, program, or course list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":"30",
            "type":"string",
            "description":"Full description of the curriculum type.",
            "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"
            }
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditCurriculumId":{
            "type":"integer",
            "description":"Unique identifier of the curriculum assigned to the student for a particular credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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

creditAmountTypeCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_CREDIT_AMOUNT_TYPE%2CApplicationCode%3DHES

The following properties are defined on the LOV link relation:

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

creditAssignmentStatusCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_CRD_ASSIGN_STAT_CODE

The following properties are defined on the LOV link relation:

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

creditCurriculums

Operation: /fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}/child/creditCurriculums

Parameters:

• CreditAssignmentId: $request.path.CreditAssignmentId

The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.

creditsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentCredits

Parameters:

• finder: AssignableCreditFinder

The following properties are defined on the LOV link relation:

• Source Attribute: CreditCode; Target Attribute: CreditCode
• Display Attribute: CreditName

Back to Top