Jump to

• Request
• Response

Update a student sponsor fee

patch

/fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}

Request

Path Parameters

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

• DueDateCalendarId: integer (int64)
  Title: Due Date Calendar Id

  The unique identifier of a due date calendar. Due date calendars determine the date when the fee is charged.
• DueDateCalendarName: string
  Title: Due Date Calendar

  Maximum Length: 50

  The name of the due date calendar assigned to the sponsor fee.
• FeeDescription: string
  Title: Description

  Maximum Length: 240

  The description of a sponsor fee.
• FeeName: string
  Title: Fee Name

  Maximum Length: 50

  The name of the sponsor fee.
• sponsorFeePeriods: array Sponsor Fee Periods
  Title: Sponsor Fee Periods

  The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.

{
    "type":"object",
    "properties":{
        "FeeName":{
            "title":"Fee Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sponsor fee.",
            "nullable":true
        },
        "DueDateCalendarName":{
            "title":"Due Date Calendar",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the due date calendar assigned to the sponsor fee.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "DueDateCalendarId"
                ]
            }
        },
        "FeeDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a sponsor fee.",
            "nullable":true
        },
        "DueDateCalendarId":{
            "title":"Due Date Calendar Id",
            "type":"integer",
            "description":"The unique identifier of a due date calendar. Due date calendars determine the date when the fee is charged.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "sponsorFeePeriods":{
            "title":"Sponsor Fee Periods",
            "type":"array",
            "description":"The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.",
            "items":{
                "$ref":"#/components/schemas/studentSponsorFees-sponsorFeePeriods-item-patch-request"
            }
        }
    }
}

Nested Schema : Sponsor Fee Periods

Type: array

Title: Sponsor Fee Periods

The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.

Show Source

• Array of: object schema

{
    "title":"Sponsor Fee Periods",
    "type":"array",
    "description":"The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.",
    "items":{
        "$ref":"#/components/schemas/studentSponsorFees-sponsorFeePeriods-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CreditTransactionTypeId: integer (int64)
  Title: Credit Transaction Type

  The transaction type used when the charge for this fee is credited.
• CreditTransactionTypeName: string
  Title: Credit Transaction Type Name

  Maximum Length: 20

  The name of the credit transaction type.
• MemoLineId: integer (int64)
  Title: Memo Line ID

  The unique identifier of the memo line used when the fee is charged for the academic period.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line.
• TransactionTypeId: integer (int64)
  Title: Transaction Type

  The transaction type used when the fee is charged for the academic period.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  The name of the transaction type.
• TrxnDescription: string
  Title: Description

  Maximum Length: 100

  The description of the transaction.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "TransactionTypeId"
                ]
            }
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "MemoLineId"
                ]
            }
        },
        "CreditTransactionTypeName":{
            "title":"Credit Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"The name of the credit transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CreditTransactionTypeId"
                ]
            }
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "type":"integer",
            "description":"The transaction type used when the fee is charged for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TrxnDescription":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the transaction.",
            "nullable":false
        },
        "CreditTransactionTypeId":{
            "title":"Credit Transaction Type",
            "type":"integer",
            "description":"The transaction type used when the charge for this fee is credited.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"The unique identifier of the memo line used when the fee is charged for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "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 : studentSponsorFees-item-response

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Unique identifier of the business unit associated to the sponsor fee.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 240

  The name of the business unit associated to the sponsor fee.
• DueDateCalendarId: integer (int64)
  Title: Due Date Calendar Id

  The unique identifier of a due date calendar. Due date calendars determine the date when the fee is charged.
• DueDateCalendarName: string
  Title: Due Date Calendar

  Maximum Length: 50

  The name of the due date calendar assigned to the sponsor fee.
• FeeDescription: string
  Title: Description

  Maximum Length: 240

  The description of a sponsor fee.
• FeeId: integer (int64)
  Title: Fee ID

  The unique identifier of a sponsor fee. Generated during a creation action.
• FeeName: string
  Title: Fee Name

  Maximum Length: 50

  The name of the sponsor fee.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• sponsorFeePeriods: array Sponsor Fee Periods
  Title: Sponsor Fee Periods

  The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.
• UserFeeCode: string
  Title: Fee Code

  Maximum Length: 30

  The unique code for a sponsor fee.

{
    "type":"object",
    "properties":{
        "FeeName":{
            "title":"Fee Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sponsor fee.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDateCalendarName":{
            "title":"Due Date Calendar",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the due date calendar assigned to the sponsor fee.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "DueDateCalendarId"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier of the business unit associated to the sponsor fee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"The unique identifier of a sponsor fee. Generated during a creation action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UserFeeCode":{
            "title":"Fee Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a sponsor fee.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a sponsor fee.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDateCalendarId":{
            "title":"Due Date Calendar Id",
            "type":"integer",
            "description":"The unique identifier of a due date calendar. Due date calendars determine the date when the fee is charged.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit associated to the sponsor fee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "sponsorFeePeriods":{
            "title":"Sponsor Fee Periods",
            "type":"array",
            "description":"The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.",
            "items":{
                "$ref":"#/components/schemas/studentSponsorFees-sponsorFeePeriods-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 : Sponsor Fee Periods

Type: array

Title: Sponsor Fee Periods

The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.

Show Source

• Array of: object studentSponsorFees-sponsorFeePeriods-item-response

{
    "title":"Sponsor Fee Periods",
    "type":"array",
    "description":"The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.",
    "items":{
        "$ref":"#/components/schemas/studentSponsorFees-sponsorFeePeriods-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : studentSponsorFees-sponsorFeePeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  The academic period valid for the sponsor fee.
• CreditTransactionTypeId: integer (int64)
  Title: Credit Transaction Type

  The transaction type used when the charge for this fee is credited.
• CreditTransactionTypeName: string
  Title: Credit Transaction Type Name

  Maximum Length: 20

  The name of the credit transaction type.
• FeeAttributeId: integer (int64)
  Title: Fee Attribute ID

  The unique identifier of the fee attribute. Generated during a creation action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  Title: Memo Line ID

  The unique identifier of the memo line used when the fee is charged for the academic period.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line.
• PeriodName: string
  Title: Academic Period

  Maximum Length: 50

  The name of an academic period.
• TransactionTypeId: integer (int64)
  Title: Transaction Type

  The transaction type used when the fee is charged for the academic period.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  The name of the transaction type.
• TrxnDescription: string
  Title: Description

  Maximum Length: 100

  The description of the transaction.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "TransactionTypeId"
                ]
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "MemoLineId"
                ]
            },
            "x-queryable":true
        },
        "CreditTransactionTypeName":{
            "title":"Credit Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"The name of the credit transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CreditTransactionTypeId"
                ]
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "type":"integer",
            "description":"The transaction type used when the fee is charged for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TrxnDescription":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditTransactionTypeId":{
            "title":"Credit Transaction Type",
            "type":"integer",
            "description":"The transaction type used when the charge for this fee is credited.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Academic Period",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an academic period.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AcademicPeriodId"
                ]
            },
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The academic period valid for the sponsor fee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeAttributeId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the fee attribute. Generated during a creation action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"The unique identifier of the memo line used when the fee is charged for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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"
    }
}

Links

dueDateCalendarsLOV

Operation: /fscmRestApi/resources/11.13.18.05/dueDateCalendarsLOV

Parameters:

• finder: ByPivotDateFinder

The following properties are defined on the LOV link relation:

• Source Attribute: DueDateCalendarName; Target Attribute: DueDateCalendarName
• Display Attribute: DueDateCalendarName

sponsorFeePeriods

Operation: /fscmRestApi/resources/11.13.18.05/studentSponsorFees/{FeeId}/child/sponsorFeePeriods

Parameters:

• FeeId: $request.path.FeeId

The sponsor fee periods resource captures the information required to post a sponsor charge for each academic period.

studentFinancialSystemConfigurationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

Back to Top