Jump to

• Request
• Response

Update a credit assignment

patch

/fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{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=
• studentCreditSponsorshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Credits Sponsorship resource and used to uniquely identify an instance of Student Credits Sponsorship. The client should not generate the hash key value. Instead, the client should query on the Student Credits Sponsorship collection resource in order to navigate to a specific instance of Student Credits Sponsorship 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

• Comments: string (byte)
  User-defined notes on the student's 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.
• StatusCode: string
  Maximum Length: 30

  Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.

{
    "type":"object",
    "properties":{
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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/studentCreditSponsorships-creditAssignments-creditCurriculums-item-patch-request"
            }
        },
        "Comments":{
            "type":"string",
            "description":"User-defined notes on the student's credit assignment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":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 studentCreditSponsorships-creditAssignments-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/studentCreditSponsorships-creditAssignments-creditCurriculums-item-patch-request"
    }
}

Nested Schema : studentCreditSponsorships-creditAssignments-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 : studentCreditSponsorships-creditAssignments-item-response

Type: object

Show Source

• AcademicPeriodId: integer
  Unique identifier of the academic period associated with the credit.
• AcademicPeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  Name of the academic period associated with the credit.
• Comments: string (byte)
  User-defined notes on the student's credit assignment.
• CreditAssignmentId: integer (int64)
  Unique identifier of the student assignment for the 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.
• links: array Links
  Title: Links

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

  Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Full description of the status set for the student assignment.
• StudentName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the student.
• StudentPartyId: integer (int64)
  Unique identifier of the student assigned to the credit.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Full description of the status set for the student assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the academic period associated with the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "type":"string",
            "description":"User-defined notes on the student's credit assignment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StudentPartyId":{
            "type":"integer",
            "description":"Unique identifier of the student assigned to the credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period associated with the credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StudentName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the student.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the student assignment for the credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the student's credit assignment. Contains one of these values: active, inactive, or canceled.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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/studentCreditSponsorships-creditAssignments-creditCurriculums-item-response"
            }
        }
    }
}

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 studentCreditSponsorships-creditAssignments-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/studentCreditSponsorships-creditAssignments-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 : studentCreditSponsorships-creditAssignments-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

creditCurriculums

Operation: /fscmRestApi/resources/11.13.18.05/studentCreditSponsorships/{studentCreditSponsorshipsUniqID}/child/creditAssignments/{CreditAssignmentId}/child/creditCurriculums

Parameters:

• CreditAssignmentId: $request.path.CreditAssignmentId
• studentCreditSponsorshipsUniqID: $request.path.studentCreditSponsorshipsUniqID

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

statusCodesLOV

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: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top