Create a fee association
post
/fscmRestApi/resources/11.13.18.05/feeAssociations
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the fee association is active or inactive. The default value is true. -
AssociationTypeCode: string
Title:
Association Type Code
Maximum Length:30
Determines whether the fee association record is linked to an object or criteria. -
AutomaticSubmitFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether requests are automatically processed even when there are issues posting transactions to the user's account. -
BusinessUnitId(required): integer
(int64)
Title:
Business Unit ID
Unique identifier for a business unit associated with the fee association. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
FeeAssociationDescription: string
Title:
Fee Association Description
Maximum Length:240
Description of the fee association. -
feeAssociationFees: array
Fee Association Fees
Title:
Fee Association Fees
The fee association fees resource stores the fees used in a fee association. -
FeeAssociationGroupCode(required): string
Title:
Fee Association Group Code
Maximum Length:50
Unique, user-defined code for the fee association group. -
FeeAssociationGroupId(required): integer
(int64)
Title:
Fee Association Group ID
Unique identifier for the fee association group. -
FeeAssociationName(required): string
Title:
Fee Association Name
Maximum Length:50
Name of the fee association. -
FeeAssociationNameCode(required): string
Title:
Fee Association Name Code
Maximum Length:50
Unique, user-defined code for the fee association. -
feeAssociationObjects: array
Fee Associations Object
Title:
Fee Associations Object
Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association. -
FeePostOptionCode: string
Title:
Fee Post Option Code
Maximum Length:30
Indicates whether the fees should be posted to the student account or another location. -
PayNowFlag: boolean
Title:
Require immediate payment
Maximum Length:1
Default Value:true
Indicates whether the fees must be paid now or can be paid at a later time. The default value is true.
Nested Schema : Fee Association Fees
Type:
array
Title:
Fee Association Fees
The fee association fees resource stores the fees used in a fee association.
Show Source
Nested Schema : Fee Associations Object
Type:
array
Title:
Fee Associations Object
Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
feeAssociationAttributes: array
Fee Association Attributes
Title:
Fee Association Attributes
The fee association attributes resource stores the attributes used for a fee in a fee association. -
FeeId(required): integer
(int64)
Title:
Fee ID
Unique identifier for the fee being associated. -
FeeName(required): string
Title:
Fee Name
Maximum Length:50
Name of the fee.
Nested Schema : Fee Association Attributes
Type:
array
Title:
Fee Association Attributes
The fee association attributes resource stores the attributes used for a fee in a fee association.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttributeId: integer
(int64)
Title:
Attribute ID
Unique identifier for a data artifact element attribute. -
AttributeRowNumber: integer
(int32)
Title:
Attribute Row Number
Row number of the attribute in relation to other attributes. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:512
Value of the data artifact element attribute. -
UseAllValuesFlag: boolean
Title:
Use All Values
Maximum Length:1
Indicates whether all attribute values or a specific attribute value is used.
Nested Schema : feeAssociations-feeAssociationObjects-item-post-request
Type:
Show Source
object
-
ObjectCode: string
Maximum Length:
100
Code of the object mapped to the fee association.
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.
Root Schema : feeAssociations-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the fee association is active or inactive. The default value is true. -
ArtifactGroupCode: string
Title:
Data Group Code
Read Only:true
Maximum Length:50
The artifact group unique code. -
ArtifactGroupId: integer
(int64)
Title:
Data Group ID
Read Only:true
Data artifact group unique identifier. -
ArtifactGroupName: string
Title:
Data Group Name
Read Only:true
Maximum Length:50
The name of an artifact group. -
AssociationTypeCode: string
Title:
Association Type Code
Maximum Length:30
Determines whether the fee association record is linked to an object or criteria. -
AssociationTypeMeaning: string
Title:
Association Type
Read Only:true
Maximum Length:80
Description of the association type. -
AutomaticSubmitFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether requests are automatically processed even when there are issues posting transactions to the user's account. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Unique identifier for a business unit associated with the fee association. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
FeeAssociationDescription: string
Title:
Fee Association Description
Maximum Length:240
Description of the fee association. -
feeAssociationFees: array
Fee Association Fees
Title:
Fee Association Fees
The fee association fees resource stores the fees used in a fee association. -
FeeAssociationGroupCode: string
Title:
Fee Association Group Code
Maximum Length:50
Unique, user-defined code for the fee association group. -
FeeAssociationGroupId: integer
(int64)
Title:
Fee Association Group ID
Unique identifier for the fee association group. -
FeeAssociationGroupName: string
Title:
Fee Association Group Name
Read Only:true
Maximum Length:50
Name of the fee association group. -
FeeAssociationId: integer
(int64)
Title:
Fee Association ID
Read Only:true
Unique identifier for a fee association. -
FeeAssociationName: string
Title:
Fee Association Name
Maximum Length:50
Name of the fee association. -
FeeAssociationNameCode: string
Title:
Fee Association Name Code
Maximum Length:50
Unique, user-defined code for the fee association. -
feeAssociationObjects: array
Fee Associations Object
Title:
Fee Associations Object
Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association. -
FeePostOptionCode: string
Title:
Fee Post Option Code
Maximum Length:30
Indicates whether the fees should be posted to the student account or another location. -
FeePostOptionMeaning: string
Title:
Fee Post Option
Read Only:true
Maximum Length:80
Meaning of the fee option code. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayNowFlag: boolean
Title:
Require immediate payment
Maximum Length:1
Default Value:true
Indicates whether the fees must be paid now or can be paid at a later time. The default value is true.
Nested Schema : Fee Association Fees
Type:
array
Title:
Fee Association Fees
The fee association fees resource stores the fees used in a fee association.
Show Source
Nested Schema : Fee Associations Object
Type:
array
Title:
Fee Associations Object
Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : feeAssociations-feeAssociationFees-item-response
Type:
Show Source
object
-
feeAssociationAttributes: array
Fee Association Attributes
Title:
Fee Association Attributes
The fee association attributes resource stores the attributes used for a fee in a fee association. -
FeeAssociationFeeId: integer
(int64)
Title:
Fee Association Fee ID
Read Only:true
Unique identifier for a fee in a fee association. -
FeeId: integer
(int64)
Title:
Fee ID
Unique identifier for the fee being associated. -
FeeName: string
Title:
Fee Name
Maximum Length:50
Name of the fee. -
FeeTypeId: integer
(int64)
Title:
Fee Type ID
Read Only:true
Unique identifier for a fee type. -
FeeTypeName: string
Title:
Fee Type Name
Read Only:true
Maximum Length:50
Name of the fee type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Fee Association Attributes
Type:
array
Title:
Fee Association Attributes
The fee association attributes resource stores the attributes used for a fee in a fee association.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : feeAssociations-feeAssociationFees-feeAssociationAttributes-item-response
Type:
Show Source
object
-
AllowChangesTypeCode: string
Title:
Allow Changes
Read Only:true
Maximum Length:30
Indicates when an element attribute is updatable. -
AllowLovAllFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, the value All appears in the list of values for the association criteria. -
AllowLovMultipleFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, multiple values can be selected from the list of values for the association criteria. -
AttributeCode: string
Title:
Attribute Code
Read Only:true
Maximum Length:50
The data artifact element attribute unique code. -
AttributeCodeAlias: string
Title:
Attribute Alias
Read Only:true
Maximum Length:500
The alias of the element attribute. -
AttributeDataTypeCode: string
Title:
Data Type Code
Read Only:true
Maximum Length:30
The type of the data artifact element attribute, for example, integer or string. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeDecimalPlaces: integer
(int64)
Title:
Decimal Places
Read Only:true
The precision of an element attribute. -
AttributeId: integer
(int64)
Title:
Attribute ID
Unique identifier for a data artifact element attribute. -
AttributeLength: integer
(int64)
Title:
Attribute Length
Read Only:true
The length of an element attribute. -
AttributeName: string
Title:
Attribute Name
Read Only:true
Maximum Length:50
The name of the data artifact element attribute. -
AttributeRowNumber: integer
(int32)
Title:
Attribute Row Number
Row number of the attribute in relation to other attributes. -
AttributeSequence: integer
(int32)
Title:
Attribute Sequence
Read Only:true
The sequence of the attribute in the element. -
AttributeTypeMeaning: string
Title:
Data Type
Read Only:true
Maximum Length:80
The meaning of the element attribute data type code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:512
Value of the data artifact element attribute. -
AttributeWeight: number
Title:
Weight
Read Only:true
The importance of an element attribute. -
DefaultValue: string
Title:
Default Value
Read Only:true
Maximum Length:512
The default value of an element attribute. -
Description: string
Title:
Attribute Description
Read Only:true
Maximum Length:240
The description of a data artifact element attribute. -
FeeAssociationAttributeId: integer
(int64)
Title:
Fee Association Attribute ID
Read Only:true
Unique identifier for a fee attribute used in the fee association. -
FinderAttributeNameFive: string
Title:
Finder 5 Name
Read Only:true
Maximum Length:512
The finder name 5 of an element attribute. -
FinderAttributeNameFour: string
Title:
Finder 4 Name
Read Only:true
Maximum Length:512
The finder name 4 of an element attribute. -
FinderAttributeNameOne: string
Title:
Finder 1 Name
Read Only:true
Maximum Length:512
The finder name 1 of an element attribute. -
FinderAttributeNameThree: string
Title:
Finder 3 Name
Read Only:true
Maximum Length:512
The finder name 3 of an element attribute. -
FinderAttributeNameTwo: string
Title:
Finder 2 Name
Read Only:true
Maximum Length:512
The finder name 2 of an element attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupTypeCode: string
Title:
List of Values Lookup Type
Read Only:true
Maximum Length:30
The list of values lookup type of an element attribute. -
LovArtifactId: integer
(int64)
Title:
List of Values Resource ID
Read Only:true
The list of values resource ID of an element attribute. -
LovDisplayFields: string
Title:
List of Values Display Fields
Read Only:true
Maximum Length:900
The comma-separated field names of the list of values resource associated with this attribute. -
LovFinderName: string
Title:
List of Values Finder Name
Read Only:true
Maximum Length:512
The list of values finder name of an element attribute. -
LovSourceResourceName: string
Title:
List of Values Source Resource Name
Read Only:true
Maximum Length:200
The source resource name for the list of values resource of an element attribute. -
LovValueField: string
Title:
List of Values Field
Read Only:true
Maximum Length:900
The field name of the list of values resource associated with this attribute. -
MaximumInRange: integer
(int64)
Title:
Maximum Value
Read Only:true
The maximum value of an element attribute. -
MinimumInRange: integer
(int64)
Title:
Minimum Value
Read Only:true
The minimum value of an element attribute. -
ParentAttributeIdFive: integer
(int64)
Title:
Parent Attribute 5 ID
Read Only:true
The parent attribute 5 of an element attribute. -
ParentAttributeIdFour: integer
(int64)
Title:
Parent Attribute 4 ID
Read Only:true
The parent attribute 4 of an element attribute. -
ParentAttributeIdOne: integer
(int64)
Title:
Parent Attribute 1 ID
Read Only:true
The parent attribute 1 of an element attribute. -
ParentAttributeIdThree: integer
(int64)
Title:
Parent Attribute 3 ID
Read Only:true
The parent attribute 3 of an element attribute. -
ParentAttributeIdTwo: integer
(int64)
Title:
Parent Attribute 2 ID
Read Only:true
The parent attribute 2 of an element attribute. -
PrimaryObjectFlag: boolean
Title:
Primary Object
Read Only:true
Maximum Length:1
Indicates when an element attribute is primary. -
QueryableFlag: boolean
Title:
Can Be Queried
Read Only:true
Maximum Length:1
Indicates whether an element attribute can be queried. -
RequiredFlag: boolean
Title:
Required
Read Only:true
Maximum Length:1
Indicates whether an element attribute is required. -
SourceObjectName: string
Title:
Source Object Name
Read Only:true
Maximum Length:200
The name of the attribute in the source object that's represented by this element, such as the REST resource attribute name or the view object attribute name. -
TranslatableFlag: boolean
Title:
Translatable
Read Only:true
Maximum Length:1
Indicates whether an element attribute is translatable. -
UpdatableFlag: boolean
Title:
Updatable
Read Only:true
Maximum Length:1
Indicates whether an element attribute is updatable. -
UseAllValuesFlag: boolean
Title:
Use All Values
Maximum Length:1
Indicates whether all attribute values or a specific attribute value is used.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : feeAssociations-feeAssociationObjects-item-response
Type:
Show Source
object
-
FeeAssociationObjectId: integer
(int64)
Read Only:
true
Unique identifier of the object mapped to the fee association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCode: string
Maximum Length:
100
Code of the object mapped to the fee association.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- artifactDataGroupsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ArtifactGroupCode; Target Attribute: ArtifactGroupCode
- Display Attribute: ArtifactGroupName
- associationTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_ASSOCIATION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AssociationTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- feeAssociationFees
-
Operation: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFeesParameters:
- FeeAssociationId:
$request.path.FeeAssociationId
The fee association fees resource stores the fees used in a fee association. - FeeAssociationId:
- feeAssociationGroupsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: FeeAssociationGroupCode; Target Attribute: FeeAssociationGroupCode
- Display Attribute: FeeAssociationGroupName
- feeAssociationObjects
-
Operation: /fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationObjectsParameters:
- FeeAssociationId:
$request.path.FeeAssociationId
Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association. - FeeAssociationId:
- genericLookupsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_FEE_POST_OPTION
The following properties are defined on the LOV link relation:- Source Attribute: FeePostOptionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- studentFinancialSystemConfigurationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name