Jump to

• Request
• Response

Get all student credits

get

/fscmRestApi/resources/11.13.18.05/studentCredits

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • AdvancedSearchFinder Finds the student credits that match the search criteria.
    Finder Variables
    • AcademicPeriodEndDate; string; The end date of the academic period.
    • AcademicPeriodStartDate; string; The start date of the academic period.
    • Keyword; string; The keywords associated with the student credit.
  • AssignableCreditFinder Finds the student credit that can be assigned to a student.
    Finder Variables
  • CreditPostingFinder Finds the student credit that can be posted as a transaction to a customer account.
    Finder Variables
  • PrimaryKey Finds the student credit that matches the primary key criteria specified.
    Finder Variables
    • CreditId; integer; The unique identifier of the student credit.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BillToSponsorFlag; boolean; Indicates whether a credit should be billed to a sponsor.
  • BusinessUnitId; integer; Unique identifier of the business unit.
  • BusinessUnitName; string; The name of the business unit.
  • ChargePriorityCode; string; Code for the charge priority rules applicable for the credit.
  • ChargePriorityId; integer; ID for the charge priority rules applicable for the credit.
  • ChargePriorityName; string; Name of the charge priority rules applicable for the credit.
  • CreditCode; string; Unique user-defined credit code.
  • CreditDescription; string; Description of the credit.
  • CreditId; integer; Unique identifier of the credit.
  • CreditName; string; Name of the credit.
  • CreditSourceCode; string; Unique code of the credit source.
  • CreditSourceMeaning; string; The name of the source of the credit.
  • CreditTypeId; integer; Unique identifier for the credit type. A list of accepted values is defined in the lookup type ORA_HES_CREDIT_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
  • CreditTypeName; string; Name of the credit type.
  • CurrencyCode; string; The currency code associated with the student credit.
  • Priority; integer; The priority in which a credit is processed.
  • StatusCode; string; The activation status of the student credit.
  • StatusMeaning; string; The activation status name of the student credit.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : studentCredits

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/studentCredits-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentCredits-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentCredits-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 : studentCredits-item-response

Type: object

Show Source

• BillToSponsorFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether a credit should be billed to a sponsor.
• BusinessUnitId: integer (int64)
  Read Only: true

  Unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit.
• ChargePriorityCode: string
  Read Only: true

  Maximum Length: 30

  Code for the charge priority rules applicable for the credit.
• ChargePriorityId: integer (int64)
  Read Only: true

  ID for the charge priority rules applicable for the credit.
• ChargePriorityName: string
  Read Only: true

  Maximum Length: 50

  Name of the charge priority rules applicable for the credit.
• CreditCode: string
  Read Only: true

  Maximum Length: 30

  Unique user-defined credit code.
• CreditDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the credit.
• CreditId: integer (int64)
  Read Only: true

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

  Maximum Length: 50

  Name of the credit.
• CreditSourceCode: string
  Read Only: true

  Maximum Length: 30

  Unique code of the credit source.
• CreditSourceMeaning: string
  Read Only: true

  Maximum Length: 80

  The name of the source of the credit.
• CreditTypeId: integer (int64)
  Read Only: true

  Unique identifier for the credit type. A list of accepted values is defined in the lookup type ORA_HES_CREDIT_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
• CreditTypeName: string
  Read Only: true

  Maximum Length: 50

  Name of the credit type.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The currency code associated with the student credit.
• FinancialAidFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a credit is eligible for financial aid. If it's eligible, the value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Priority: integer (int32)
  Read Only: true

  The priority in which a credit is processed.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  The activation status of the student credit.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The activation status name of the student credit.

{
    "type":"object",
    "properties":{
        "CreditCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined credit code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeId":{
            "type":"integer",
            "description":"Unique identifier for the credit type. A list of accepted values is defined in the lookup type ORA_HES_CREDIT_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CreditTypeName"
                ]
            },
            "x-queryable":true
        },
        "CreditTypeName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"The priority in which a credit is processed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "CreditName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the charge priority rules applicable for the credit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The activation status of the student credit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargePriorityName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the charge priority rules applicable for the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the student credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditSourceMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the source of the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The activation status name of the student credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"Unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FinancialAidFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a credit is eligible for financial aid. If it's eligible, the value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePriorityId":{
            "type":"integer",
            "description":"ID for the charge priority rules applicable for the credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargePriorityCode"
                ]
            },
            "x-queryable":true
        },
        "CreditSourceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the credit source.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToSponsorFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a credit should be billed to a sponsor.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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."
        }
    }
}

Back to Top