Jump to

• Request
• Response

Get all student sponsorship credits

get

/fscmRestApi/resources/11.13.18.05/studentCreditSponsorships

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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
  
  

  • PrimaryKey Finds the student sponsorship credit that matches the primary key criteria specified.
    Finder Variables
    • CreditId; integer; The unique identifier of the student sponsorship 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; This indicates whether or not a sponsor should be billed for the credit. The default value is false.
  • BusinessUnitId; integer; Unique identifier of the business unit.
  • BusinessUnitName; string; Name of the business unit.
  • ChargePriorityCode; string; Unique code of the charge priority mapping.
  • ChargePriorityId; integer; Unique identifier of the charge priority mapping.
  • ChargePriorityName; string; Name of the charge priority mapping.
  • CreditCode; string; Unique user-defined credit code.
  • CreditDescription; string; User-defined information about the credit.
  • CreditId; integer; Unique identifier of the credit.
  • CreditName; string; Name of the credit.
  • CreditReferenceCode; string; Unique code for the external source of the disbursed amount.
  • CreditReferenceMeaning; string; Name of the source of financial aid.
  • CreditSourceCode; string; Unique code of the credit source.
  • CreditSourceMeaning; string; Description of the source of the credit.
  • CurrencyCode; string; Unique code for the currency used in the primary ledger of the business unit.
  • CurrencySymbol; string; Symbol of the applicable currency.
  • InstitutionId; integer; Unique identifier of the institution associated with the credit.
  • InstitutionName; string; Name of the institution.
  • MaximumAmount; number; Maximum amount of the credit.
  • Priority; integer; Priority assigned to the credit.
  • RefundableFlag; boolean; This indicates that refunds are allowed for this credit. The default value is false.
  • SetupTypeCode; string; The unique code indicating the setup type of the sponsorship.
  • SetupTypeName; string; The name of the setup type of the sponsorship.
  • SponsorAgreementName; string; The name of the sponsorship agreement.
  • StatusCode; string; Status of the credit. It can be active or inactive.
  • StatusMeaning; string; Full description of the status set for the credit.
  • StudentResourceFlag; boolean; This indicates that a credit can be used as student resource information. If true, the student credit is created in the HES_CREDIT_MAPPING record. The default value is false.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : studentCreditSponsorships

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/studentCreditSponsorships-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 studentCreditSponsorships-item-response

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

Type: object

Show Source

• BillToSponsorFlag: boolean
  Maximum Length: 1

  Default Value: false

  This indicates whether or not a sponsor should be billed for the credit. The default value is false.
• BusinessUnitId: integer (int64)
  Unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit.
• ChargePriorityCode: string
  Maximum Length: 30

  Unique code of the charge priority mapping.
• ChargePriorityId: integer (int64)
  Unique identifier of the charge priority mapping.
• ChargePriorityName: string
  Read Only: true

  Maximum Length: 50

  Name of the charge priority mapping.
• creditAssignments: array Credit Assignments
  Title: Credit Assignments

  The credit assignments resource is used to assign a student to a sponsorship credit.
• CreditCode: string
  Maximum Length: 30

  Unique user-defined credit code.
• CreditDescription: string
  Maximum Length: 240

  User-defined information about the credit.
• CreditId: integer (int64)
  Read Only: true

  Unique identifier of the credit.
• CreditName: string
  Maximum Length: 50

  Name of the credit.
• creditPeriods: array Credit Periods
  Title: Credit Periods

  The credit periods resource is used to associate reporting academic periods with a sponsorship credit.
• CreditReferenceCode: string
  Unique code for the external source of the disbursed amount.
• CreditReferenceMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the source of financial aid.
• CreditSourceCode: string
  Maximum Length: 30

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

  Maximum Length: 80

  Description of the source of the credit.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Unique code for the currency used in the primary ledger of the business unit.
• CurrencySymbol: string
  Title: Symbol

  Read Only: true

  Maximum Length: 12

  Symbol of the applicable currency.
• InstitutionId: integer
  Unique identifier of the institution associated with the credit.
• InstitutionName: string
  Name of the institution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAmount: number
  Maximum amount of the credit.
• Priority: integer (int32)
  Default Value: 9999

  Priority assigned to the credit.
• RefundableFlag: boolean
  Maximum Length: 1

  Default Value: false

  This indicates that refunds are allowed for this credit. The default value is false.
• SetupTypeCode: string
  Title: Type

  Maximum Length: 30

  The unique code indicating the setup type of the sponsorship.
• SetupTypeName: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The name of the setup type of the sponsorship.
• SponsorAccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 255

  The account number of the sponsor.
• SponsorAgreementName: string
  Title: Agreement Name

  Read Only: true

  Maximum Length: 50

  The name of the sponsorship agreement.
• SponsorPartyName: string
  Title: Sponsor

  Read Only: true

  Maximum Length: 255

  The name of the organization which is associated as a sponsor.
• StatusCode: string
  Maximum Length: 30

  Status of the credit. It can be active or inactive.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Full description of the status set for the credit.
• StudentResourceFlag: boolean
  Maximum Length: 1

  Default Value: false

  This indicates that a credit can be used as student resource information. If true, the student credit is created in the HES_CREDIT_MAPPING record. The default value is false.

{
    "type":"object",
    "properties":{
        "CreditCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined credit code.",
            "nullable":false,
            "x-queryable":true
        },
        "MaximumAmount":{
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "creditAssignments":{
            "title":"Credit Assignments",
            "type":"array",
            "description":"The credit assignments resource is used to assign a student to a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-item-response"
            }
        },
        "ChargePriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the charge priority mapping.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the credit. It can be active or inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Symbol",
            "maxLength":12,
            "type":"string",
            "description":"Symbol of the applicable currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Unique code for the currency used in the primary ledger of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SponsorPartyName":{
            "title":"Sponsor",
            "maxLength":255,
            "type":"string",
            "description":"The name of the organization which is associated as a sponsor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreditId",
                    "SponsorPartyId"
                ]
            }
        },
        "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
        },
        "creditPeriods":{
            "title":"Credit Periods",
            "type":"array",
            "description":"The credit periods resource is used to associate reporting academic periods with a sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-item-response"
            }
        },
        "StudentResourceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates that a credit can be used as student resource information. If true, the student credit is created in the HES_CREDIT_MAPPING record. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SetupTypeName":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the setup type of the sponsorship.",
            "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"
            }
        },
        "CreditDescription":{
            "maxLength":240,
            "type":"string",
            "description":"User-defined information about the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePriorityId":{
            "type":"integer",
            "description":"Unique identifier of the charge priority mapping.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "type":"string",
            "description":"Name of the institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CreditMappingInstitutionName",
                    "CreditsInstitutionName"
                ]
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "type":"integer",
            "description":"Unique identifier of the institution associated with the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillToSponsorFlag",
                    "StudentResourceFlag"
                ]
            },
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority assigned to the credit.",
            "format":"int32",
            "nullable":false,
            "default":9999,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditReferenceMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the source of financial aid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit.",
            "nullable":false,
            "x-queryable":true
        },
        "SponsorAgreementName":{
            "title":"Agreement Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the sponsorship agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePriorityName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the charge priority mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditReferenceCode":{
            "type":"string",
            "description":"Unique code for the external source of the disbursed amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StudentResourceFlag"
                ]
            },
            "x-queryable":true
        },
        "CreditSourceMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the source of the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Full description of the status set for the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SetupTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The unique code indicating the setup type of the sponsorship.",
            "nullable":true,
            "x-queryable":true
        },
        "SponsorAccountNumber":{
            "title":"Account Number",
            "maxLength":255,
            "type":"string",
            "description":"The account number of the sponsor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SponsorPartyId"
                ]
            }
        },
        "RefundableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates that refunds are allowed for this credit. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditSourceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the credit source.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToSponsorFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates whether or not a sponsor should be billed for the credit. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Credit Assignments

Type: array

Title: Credit Assignments

The credit assignments resource is used to assign a student to a sponsorship credit.

Show Source

• Array of: object studentCreditSponsorships-creditAssignments-item-response

{
    "title":"Credit Assignments",
    "type":"array",
    "description":"The credit assignments resource is used to assign a student to a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditAssignments-item-response"
    }
}

Nested Schema : Credit Periods

Type: array

Title: Credit Periods

The credit periods resource is used to associate reporting academic periods with a sponsorship credit.

Show Source

• Array of: object studentCreditSponsorships-creditPeriods-item-response

{
    "title":"Credit Periods",
    "type":"array",
    "description":"The credit periods resource is used to associate reporting academic periods with a sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-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-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."
        }
    }
}

Nested Schema : studentCreditSponsorships-creditPeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Period Name

  Maximum Length: 50

  Name of the academic period.
• creditPeriodCurriculums: array Credit Period Curriculums
  Title: Credit Period Curriculums

  The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.
• CreditPeriodDescription: string
  Maximum Length: 240

  Name of the credit period.
• CreditPeriodId: integer (int64)
  Read Only: true

  Unique identifier of the credit period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  The unique identifier of the memo line used when the credit is posted for the academic period.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line.
• ReceivableActivityId: integer (int64)
  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Name of the receivables activity.
• TransactionTypeId: integer (int64)
  Unique identifier of the transaction type when the credit is posted for the academic period.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the transaction type.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditPeriodDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the credit period.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "type":"string",
            "description":"Name of the receivables activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReceivableActivityId":{
            "type":"integer",
            "description":"Unique identifier of the receivables activity when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "creditPeriodCurriculums":{
            "title":"Credit Period Curriculums",
            "type":"array",
            "description":"The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.",
            "items":{
                "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response"
            }
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the credit period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier of the memo line used when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Credit Period Curriculums

Type: array

Title: Credit Period Curriculums

The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.

Show Source

• Array of: object studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-item-response

{
    "title":"Credit Period Curriculums",
    "type":"array",
    "description":"The credit period curriculums resource is used to associate curriculums with the academic periods that are already associated to the sponsorship credit.",
    "items":{
        "$ref":"#/components/schemas/studentCreditSponsorships-creditPeriods-creditPeriodCurriculums-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-creditPeriods-creditPeriodCurriculums-item-response

Type: object

Show Source

• CreditPeriodCurriculumId: integer (int64)
  Read Only: true

  Unique identifier of the curriculum associated with the credit period.
• CurriculumId: integer (int64)
  Unique identifier of the curriculum.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  Name of the curriculum.
• CurriculumTypeId: integer (int64)
  Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.
• CurriculumTypeMeaning: string
  Read Only: true

  Maximum Length: 50

  Name of the curriculum type for the curriculum associated with the credit period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditPeriodCurriculumId":{
            "type":"integer",
            "description":"Unique identifier of the curriculum associated with the credit period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the curriculum.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "type":"integer",
            "description":"Unique identifier of the curriculum.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumTypeMeaning":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the curriculum type for the curriculum associated with the credit period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "type":"integer",
            "description":"Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "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"
    }
}

Back to Top