Jump to

• Request
• Response

Get all carts as administrator

get

/fscmRestApi/resources/11.13.18.05/carts

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
  
  

  • PrimaryKey Finds all carts that match the primary key criteria specified.
    Finder Variables
    • CartHeaderId; integer; Unique identifier for the cart.
  • PromotionFinder Finds all carts that match the promotion finder criteria.
    Finder Variables
    • PromoCode; string; Promotion code for the cart.
• 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:
  

  • AccountType; string; The account type of the bank account associated with the financial transaction.
  • AllowManualPaymentFlag; boolean; Indicates that the manual payment is allowed. The default value is true.
  • BankAccountNumber; string; The bank account number associated with the financial transaction.
  • BankAccountSupportFlag; boolean; Indicates that the bank account is supported. The default value is true.
  • BranchNumber; string; The branch number of the bank associated with the financial transaction.
  • BuyerPartyId; integer; The unique identifier of the party responsible for the payment.
  • CartHeaderId; integer; The unique identifier of the shopping cart header.
  • CartPaymentStatus; string; The status of payment. Payment status, such as PENDING, SUCCESS, ERROR, or MESSAGES.
  • CartProcessStatus; string; Overall processing status, such as PENDING, VALIDATED, EXPIRED, POSTED, ERROR, or MESSAGES.
  • CountryCode; string; A short alphabetic code representing the country that's used as the default address.
  • CreatedBy; string; The user who created the cart.
  • CreationDate; string; The date and time when the cart was created.
  • CreditCardSupportFlag; boolean; Indicates that the credit card is supported. The default value is true.
  • CurrencyCode; string; The currency code associated with a cart.
  • CurrencySymbol; string; The currency symbol associated with a cart.
  • EmailNotificationStatus; string; The status of the email notification process, such as SUCCESS or ERROR.
  • InstrumentPaymentUseId; string; The unique identifier of the payment method.
  • LastUpdateDate; string; The date and time when the cart was last updated.
  • LastUpdatedBy; string; The user who last updated the cart.
  • ManualPaymentInformation; string; The detailed description for the manual payment.
  • OtherPaymentURL; string; The URL address for other payment.
  • PaymentOptionCode; string; The code of the payment option.
  • PromotionCode; string; The promotion code applied to the cart.
  • SendEmailFlag; boolean; Indicates that an email communication can be sent to the user. The default value is false.
  • ThirdPartyTransactionAmount; string; The amount that's passed by the third party to complete the transaction.
  • TotalAmount; number; The numeric value of the total amount charge of a cart.
  • TotalDiscountAmount; number; The numeric value of the total discount amount given for a cart.
  • TransactionId; string; The unique identifier of the transaction associated with the cart.
• 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: string
  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: string
  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:
  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 : carts

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/carts-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object carts-item-response

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

Type: object

Show Source

• AccountType: string
  Title: Account Type

  The account type of the bank account associated with the financial transaction.
• AllowManualPaymentFlag: boolean
  Title: Allow Manual Payment

  Read Only: true

  Maximum Length: 255

  Indicates that the manual payment is allowed. The default value is true.
• BankAccountNumber: string
  Title: Bank Account Number

  The bank account number associated with the financial transaction.
• BankAccountSupportFlag: boolean
  Title: Bank Account Support

  Read Only: true

  Indicates that the bank account is supported. The default value is true.
• BranchNumber: string
  Title: Branch Number

  The branch number of the bank associated with the financial transaction.
• BuyerPartyId: integer (int64)
  Title: Buyer Party ID

  The unique identifier of the party responsible for the payment.
• CartHeaderId: integer (int64)
  Title: Cart Header ID

  Read Only: true

  The unique identifier of the shopping cart header.
• CartPaymentConfirmationMessage: string
  Title: Cart Payment Confirmation Message

  Read Only: true

  The confirmation message after cart payment.
• CartPaymentStatus: string
  Title: Cart Payment Status

  Maximum Length: 30

  The status of payment. Payment status, such as PENDING, SUCCESS, ERROR, or MESSAGES.
• CartProcessStatus: string
  Title: Cart Process Status

  Maximum Length: 30

  Overall processing status, such as PENDING, VALIDATED, EXPIRED, POSTED, ERROR, or MESSAGES.
• CountryCode: string
  Title: Country Code

  A short alphabetic code representing the country that's used as the default address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the cart.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the cart was created.
• CreditCardSupportFlag: boolean
  Title: Credit Card Support

  Read Only: true

  Indicates that the credit card is supported. The default value is true.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  The currency code associated with a cart.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The currency symbol associated with a cart.
• CustomerAccountId: string
  Title: Customer Account ID

  Read Only: true

  The unique identifier of the customer account associated with the financial transaction.
• CustomerAccountSiteUseId: string
  Title: Customer Account Site Use ID

  Read Only: true

  The unique identifier of the bill to site of the customer account associated with the financial transaction.
• DiscountMessage: string
  Title: Discount Message

  Read Only: true

  The description of the discount applied to the cart.
• DiscountName: string
  Title: Discount Name

  Read Only: true

  The name of the discount applied to the cart.
• EmailNotificationStatus: string
  Title: Email Notification Status

  The status of the email notification process, such as SUCCESS or ERROR.
• InstrumentPaymentUseId: string
  Title: Payment Method ID

  The unique identifier of the payment method.
• IsPromotionCodeAppliedFlag: boolean
  Title: Is Promotion Code Applied

  Read Only: true

  Default Value: false

  Indicates that the promotion code is applied to the cart. The default value is false.
• IsValidatedFlag: boolean
  Title: Cart Is Valid

  Read Only: true

  Indicates that the cart is validated. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the cart was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the cart.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualPaymentInformation: string
  Title: Manual Payment Information

  Read Only: true

  The detailed description for the manual payment.
• miscellaneousFeeItems: array Miscellaneous Fee Items
  Title: Miscellaneous Fee Items

  The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.
• OrderId: string
  Title: Order ID

  The payment order number associated with the financial transaction.
• OrgId: string
  Title: Organization ID

  Read Only: true

  The unique identifier of the organization.
• OtherPaymentURL: string
  Title: Other Payment URL

  Read Only: true

  The URL address for other payment.
• PartySiteId: string
  Title: Party Site ID

  Read Only: true

  The unique identifier for the party address.
• PaymentOptionCode: string
  Title: Payment Option Code

  Read Only: true

  The code of the payment option.
• PromotionCode: string
  Title: Promotion Code

  The promotion code applied to the cart.
• scheduledCourseItems: array Scheduled Courses
  Title: Scheduled Courses

  The scheduled course items resource provides a list of scheduled course items present in the cart.
• SendEmailFlag: boolean
  Title: Send Email

  Indicates that an email communication can be sent to the user. The default value is false.
• ThirdPartyTransactionAmount: string
  Title: Third Party Transaction Amount

  The amount that's passed by the third party to complete the transaction.
• TotalAmount: number
  Title: Total Amount

  Read Only: true

  The numeric value of the total amount charge of a cart.
• TotalDiscountAmount: number
  Title: Total Discount Amount

  Read Only: true

  The numeric value of the total discount amount given for a cart.
• TransactionId: string
  Title: Transaction ID

  The unique identifier of the transaction associated with the cart.

{
    "type":"object",
    "properties":{
        "AccountType":{
            "title":"Account Type",
            "type":"string",
            "description":"The account type of the bank account associated with the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowManualPaymentFlag":{
            "title":"Allow Manual Payment",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates that the manual payment is allowed. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BankAccountNumber":{
            "title":"Bank Account Number",
            "type":"string",
            "description":"The bank account number associated with the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountSupportFlag":{
            "title":"Bank Account Support",
            "type":"boolean",
            "description":"Indicates that the bank account is supported. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BranchNumber":{
            "title":"Branch Number",
            "type":"string",
            "description":"The branch number of the bank associated with the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "BuyerPartyId":{
            "title":"Buyer Party ID",
            "type":"integer",
            "description":"The unique identifier of the party responsible for the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CartHeaderId":{
            "title":"Cart Header ID",
            "type":"integer",
            "description":"The unique identifier of the shopping cart header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CartPaymentConfirmationMessage":{
            "title":"Cart Payment Confirmation Message",
            "type":"string",
            "description":"The confirmation message after cart payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CartPaymentStatus":{
            "title":"Cart Payment Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of payment. Payment status, such as PENDING, SUCCESS, ERROR, or MESSAGES.",
            "nullable":true,
            "x-queryable":true
        },
        "CartProcessStatus":{
            "title":"Cart Process Status",
            "maxLength":30,
            "type":"string",
            "description":"Overall processing status, such as PENDING, VALIDATED, EXPIRED, POSTED, ERROR, or MESSAGES.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "type":"string",
            "description":"A short alphabetic code representing the country that's used as the default address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the cart.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the cart was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCardSupportFlag":{
            "title":"Credit Card Support",
            "type":"boolean",
            "description":"Indicates that the credit card is supported. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The currency code associated with a cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The currency symbol associated with a cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"string",
            "description":"The unique identifier of the customer account associated with the financial transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerAccountSiteUseId":{
            "title":"Customer Account Site Use ID",
            "type":"string",
            "description":"The unique identifier of the bill to site of the customer account associated with the financial transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountMessage":{
            "title":"Discount Message",
            "type":"string",
            "description":"The description of the discount applied to the cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountName":{
            "title":"Discount Name",
            "type":"string",
            "description":"The name of the discount applied to the cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailNotificationStatus":{
            "title":"Email Notification Status",
            "type":"string",
            "description":"The status of the email notification process, such as SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentPaymentUseId":{
            "title":"Payment Method ID",
            "type":"string",
            "description":"The unique identifier of the payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "IsPromotionCodeAppliedFlag":{
            "title":"Is Promotion Code Applied",
            "type":"boolean",
            "description":"Indicates that the promotion code is applied to the cart. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "IsValidatedFlag":{
            "title":"Cart Is Valid",
            "type":"boolean",
            "description":"Indicates that the cart is validated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the cart was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the cart.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualPaymentInformation":{
            "title":"Manual Payment Information",
            "type":"string",
            "description":"The detailed description for the manual payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderId":{
            "title":"Order ID",
            "type":"string",
            "description":"The payment order number associated with the financial transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "OrgId":{
            "title":"Organization ID",
            "type":"string",
            "description":"The unique identifier of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OtherPaymentURL":{
            "title":"Other Payment URL",
            "type":"string",
            "description":"The URL address for other payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"string",
            "description":"The unique identifier for the party address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PaymentOptionCode":{
            "title":"Payment Option Code",
            "type":"string",
            "description":"The code of the payment option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionCode":{
            "title":"Promotion Code",
            "type":"string",
            "description":"The promotion code applied to the cart.",
            "nullable":true,
            "x-queryable":true
        },
        "SendEmailFlag":{
            "title":"Send Email",
            "type":"boolean",
            "description":"Indicates that an email communication can be sent to the user. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdPartyTransactionAmount":{
            "title":"Third Party Transaction Amount",
            "type":"string",
            "description":"The amount that's passed by the third party to complete the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "description":"The numeric value of the total amount charge of a cart.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "TotalDiscountAmount":{
            "title":"Total Discount Amount",
            "type":"number",
            "description":"The numeric value of the total discount amount given for a cart.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"string",
            "description":"The unique identifier of the transaction associated with the cart.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "miscellaneousFeeItems":{
            "title":"Miscellaneous Fee Items",
            "type":"array",
            "description":"The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.",
            "items":{
                "$ref":"#/components/schemas/carts-miscellaneousFeeItems-item-response"
            }
        },
        "scheduledCourseItems":{
            "title":"Scheduled Courses",
            "type":"array",
            "description":"The scheduled course items resource provides a list of scheduled course items present in the cart.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-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 : Miscellaneous Fee Items

Type: array

Title: Miscellaneous Fee Items

The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.

Show Source

• Array of: object carts-miscellaneousFeeItems-item-response

{
    "title":"Miscellaneous Fee Items",
    "type":"array",
    "description":"The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.",
    "items":{
        "$ref":"#/components/schemas/carts-miscellaneousFeeItems-item-response"
    }
}

Nested Schema : Scheduled Courses

Type: array

Title: Scheduled Courses

The scheduled course items resource provides a list of scheduled course items present in the cart.

Show Source

• Array of: object carts-scheduledCourseItems-item-response

{
    "title":"Scheduled Courses",
    "type":"array",
    "description":"The scheduled course items resource provides a list of scheduled course items present in the cart.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-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 : carts-miscellaneousFeeItems-item-response

Type: object

Show Source

• CartDetailId: integer (int64)
  Title: Miscellaneous Fee Cart ID

  Read Only: true

  The unique identifier of the cart detail of the miscellaneous fee item.
• CartDetailStatus: string
  Title: Detail Status

  Read Only: true

  Maximum Length: 30

  The status of the cart detail of the miscellaneous fee item.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the miscellaneous item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the miscellaneous item was created.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The currency code associated with a miscellaneous fee.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The currency symbol associated with a miscellaneous fee.
• DiscountAmount: number
  Title: Discount Amount

  Read Only: true

  The numeric value of the discount amount given for a miscellaneous item.
• FeeAttributeId: integer (int64)
  Title: Fee Attribute ID

  The unique identifier of the miscellaneous fee attribute.
• FeeAttributeLongDescription: string
  Title: Fee Attribute Long Description

  Read Only: true

  Maximum Length: 240

  The detailed description for the miscellaneous fee attribute.
• FeeAttributeTransactionDescription: string
  Title: Fee Attribute Transaction Description

  Read Only: true

  Maximum Length: 100

  The invoices and credit memos description.
• FeeCategoryName: string
  Title: Fee Category Name

  Read Only: true

  Maximum Length: 50

  The name of the fee category.
• FeeId: integer (int64)
  Title: Fee ID

  Read Only: true

  The unique identifier for the fee to be charged to the student.
• FlatAmount: number
  Title: Amount

  Read Only: true

  The amount that will be charged for the fee. For example, a flat fee amount could be charged regardless of whether the student is an undergraduate or graduate student.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the miscellaneous item was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the miscellaneous item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• miscDiscounts: array Miscellaneous Discounts
  Title: Miscellaneous Discounts

  The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.

{
    "type":"object",
    "properties":{
        "CartDetailId":{
            "title":"Miscellaneous Fee Cart ID",
            "type":"integer",
            "description":"The unique identifier of the cart detail of the miscellaneous fee item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CartDetailStatus":{
            "title":"Detail Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the cart detail of the miscellaneous fee item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the miscellaneous item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the miscellaneous item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with a miscellaneous fee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The currency symbol associated with a miscellaneous fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"The numeric value of the discount amount given for a miscellaneous item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "FeeAttributeId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the miscellaneous fee attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "FeeAttributeLongDescription":{
            "title":"Fee Attribute Long Description",
            "maxLength":240,
            "type":"string",
            "description":"The detailed description for the miscellaneous fee attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeAttributeTransactionDescription":{
            "title":"Fee Attribute Transaction Description",
            "maxLength":100,
            "type":"string",
            "description":"The invoices and credit memos description.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCategoryName":{
            "title":"Fee Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the fee category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"The unique identifier for the fee to be charged to the student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount that will be charged for the fee. For example, a flat fee amount could be charged regardless of whether the student is an undergraduate or graduate student.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the miscellaneous item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the miscellaneous item.",
            "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"
            }
        },
        "miscDiscounts":{
            "title":"Miscellaneous Discounts",
            "type":"array",
            "description":"The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.",
            "items":{
                "$ref":"#/components/schemas/carts-miscellaneousFeeItems-miscDiscounts-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 : Miscellaneous Discounts

Type: array

Title: Miscellaneous Discounts

The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.

Show Source

• Array of: object carts-miscellaneousFeeItems-miscDiscounts-item-response

{
    "title":"Miscellaneous Discounts",
    "type":"array",
    "description":"The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.",
    "items":{
        "$ref":"#/components/schemas/carts-miscellaneousFeeItems-miscDiscounts-item-response"
    }
}

Nested Schema : carts-miscellaneousFeeItems-miscDiscounts-item-response

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 80

  Currency code for a cart item discount.
• CurrencySymbol: string
  Title: Currency Symbol

  Maximum Length: 80

  Currency symbol for a cart item discount.
• DiscountAmount: number
  Title: Discount Amount

  Amount deducted from the original cost of a cart item.
• DiscountName: string
  Title: Discount Name

  Maximum Length: 80

  Name of a discount applied to a cart item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":80,
            "type":"string",
            "description":"Currency code for a cart item discount.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":80,
            "type":"string",
            "description":"Currency symbol for a cart item discount.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"Amount deducted from the original cost of a cart item.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountName":{
            "title":"Discount Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of a discount applied to a cart item.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : carts-scheduledCourseItems-item-response

Type: object

Show Source

• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The code for the academic subject of the scheduled course.
• CartDetailId: integer (int64)
  Title: Scheduled Course Cart ID

  Read Only: true

  The unique identifier of the cart detail of the scheduled course.
• CartDetailStatus: string
  Title: Detail Status

  Read Only: true

  Maximum Length: 30

  The status of the cart detail of the scheduled course.
• courseFees: array Course Fees
  Title: Course Fees

  The course fees resource provides a list of fees associated with a course.
• courseRequisites: array Course Requisites
  Title: Course Requisites

  The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the scheduled course item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the scheduled course item was created.
• CreditTypeMeaning: string
  Title: Type of Credit Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  The currency code associated with a scheduled course fee.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The currency symbol associated with a scheduled course fee.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The code for the scheduled course.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  The unique identifier of a scheduled course.
• CurriculumOptionId: integer (int64)
  Title: Curriculum Option ID

  The unique identifier for the enrollment transaction selections made by the student for this shopping cart item.
• EnrolledCredits: number
  Title: Units

  The enrolled units for which a student can earn credit.
• GradingOptionCode: string
  Title: Grading Option Code

  Maximum Length: 255

  The code for the grading option of a scheduled course.
• GradingOptionName: string
  Title: Grading Option Name

  Read Only: true

  The name for the grading option of a scheduled course.
• IsSponsoredFlag: boolean
  Title: Sponsored

  Read Only: true

  Indicates whether the scheduled course is sponsored. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the scheduled course item was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the scheduled course item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  A numeric value indicating the minimum units of the scheduled course.
• OverallPrerequisiteStatus: string
  Title: Overall Prerequisite Status

  The status of overall prerequisite.
• OwningCurriculumId: integer (int64)
  Title: Owning Course Curriculum ID

  Read Only: true

  The name of the parent curriculum item.
• OwningCurriculumName: string
  Title: Owning Name

  Read Only: true

  Maximum Length: 50

  The unique identifier of the parent curriculum item.
• ProgramPrepaidFlag: boolean
  Title: Program Prepaid

  Read Only: true

  Indicates whether the program associated with scheduled course is prepaid. The default value is false.
• RequisiteInformation: string
  Title: Requisite Description

  Read Only: true

  The detailed description for the requisite.
• ScheduledCourseCode: string
  Title: Scheduled Course Code

  Read Only: true

  Maximum Length: 30

  The code used to identify a scheduled course within a given course and academic period.
• scheduledCourseFees: array Scheduled Course Fees
  Title: Scheduled Course Fees

  The scheduled course fees resource provides a list of fees associated with a scheduled course.
• scheduledCourses: array Scheduled Courses
  Title: Scheduled Courses

  The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.
• SelfPacedCalculatedClassEndDate: string (date)
  Title: Self-Paced End Date

  Read Only: true

  The end date of self paced classes.
• SelfPacedClassStartDate: string (date)
  Title: Self-Paced Start Date

  The start date of self paced classes.
• TotalAmount: number
  Title: Total Amount

  Read Only: true

  The numeric value of the total amount charge of a scheduled course item.
• TotalDiscountAmount: number
  Title: Total Discount Amount

  Read Only: true

  The numeric value of the total discount amount given for a scheduled course item.
• validationMessages: array Validation Messages
  Title: Validation Messages

  The validation messages resource provides a list of validation messages associated with a cart.

{
    "type":"object",
    "properties":{
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the academic subject of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CartDetailId":{
            "title":"Scheduled Course Cart ID",
            "type":"integer",
            "description":"The unique identifier of the cart detail of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CartDetailStatus":{
            "title":"Detail Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the cart detail of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the scheduled course item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the scheduled course item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The currency code associated with a scheduled course fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The currency symbol associated with a scheduled course fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The code for the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier of a scheduled course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumOptionId":{
            "title":"Curriculum Option ID",
            "type":"integer",
            "description":"The unique identifier for the enrollment transaction selections made by the student for this shopping cart item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrolledCredits":{
            "title":"Units",
            "type":"number",
            "description":"The enrolled units for which a student can earn credit.",
            "nullable":true,
            "x-queryable":true
        },
        "GradingOptionCode":{
            "title":"Grading Option Code",
            "maxLength":255,
            "type":"string",
            "description":"The code for the grading option of a scheduled course.",
            "nullable":true,
            "x-queryable":true
        },
        "GradingOptionName":{
            "title":"Grading Option Name",
            "type":"string",
            "description":"The name for the grading option of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSponsoredFlag":{
            "title":"Sponsored",
            "type":"boolean",
            "description":"Indicates whether the scheduled course is sponsored. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the scheduled course item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the scheduled course item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"A numeric value indicating the minimum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "OverallPrerequisiteStatus":{
            "title":"Overall Prerequisite Status",
            "type":"string",
            "description":"The status of overall prerequisite.",
            "nullable":true,
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Owning Course Curriculum ID",
            "type":"integer",
            "description":"The name of the parent curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OwningCurriculumName":{
            "title":"Owning Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the parent curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramPrepaidFlag":{
            "title":"Program Prepaid",
            "type":"boolean",
            "description":"Indicates whether the program associated with scheduled course is prepaid. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisiteInformation":{
            "title":"Requisite Description",
            "type":"string",
            "description":"The detailed description for the requisite.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "title":"Scheduled Course Code",
            "maxLength":30,
            "type":"string",
            "description":"The code used to identify a scheduled course within a given course and academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SelfPacedCalculatedClassEndDate":{
            "title":"Self-Paced End Date",
            "type":"string",
            "description":"The end date of self paced classes.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelfPacedClassStartDate":{
            "title":"Self-Paced Start Date",
            "type":"string",
            "description":"The start date of self paced classes.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "description":"The numeric value of the total amount charge of a scheduled course item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "TotalDiscountAmount":{
            "title":"Total Discount Amount",
            "type":"number",
            "description":"The numeric value of the total discount amount given for a scheduled course item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "courseFees":{
            "title":"Course Fees",
            "type":"array",
            "description":"The course fees resource provides a list of fees associated with a course.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-courseFees-item-response"
            }
        },
        "courseRequisites":{
            "title":"Course Requisites",
            "type":"array",
            "description":"The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-courseRequisites-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "scheduledCourseFees":{
            "title":"Scheduled Course Fees",
            "type":"array",
            "description":"The scheduled course fees resource provides a list of fees associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourseFees-item-response"
            }
        },
        "scheduledCourses":{
            "title":"Scheduled Courses",
            "type":"array",
            "description":"The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourses-item-response"
            }
        },
        "validationMessages":{
            "title":"Validation Messages",
            "type":"array",
            "description":"The validation messages resource provides a list of validation messages associated with a cart.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-validationMessages-item-response"
            }
        }
    }
}

Nested Schema : Course Fees

Type: array

Title: Course Fees

The course fees resource provides a list of fees associated with a course.

Show Source

• Array of: object carts-scheduledCourseItems-courseFees-item-response

{
    "title":"Course Fees",
    "type":"array",
    "description":"The course fees resource provides a list of fees associated with a course.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-courseFees-item-response"
    }
}

Nested Schema : Course Requisites

Type: array

Title: Course Requisites

The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.

Show Source

• Array of: object carts-scheduledCourseItems-courseRequisites-item-response

{
    "title":"Course Requisites",
    "type":"array",
    "description":"The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-courseRequisites-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 : Scheduled Course Fees

Type: array

Title: Scheduled Course Fees

The scheduled course fees resource provides a list of fees associated with a scheduled course.

Show Source

• Array of: object carts-scheduledCourseItems-scheduledCourseFees-item-response

{
    "title":"Scheduled Course Fees",
    "type":"array",
    "description":"The scheduled course fees resource provides a list of fees associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourseFees-item-response"
    }
}

Nested Schema : Scheduled Courses

Type: array

Title: Scheduled Courses

The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.

Show Source

• Array of: object carts-scheduledCourseItems-scheduledCourses-item-response

{
    "title":"Scheduled Courses",
    "type":"array",
    "description":"The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourses-item-response"
    }
}

Nested Schema : Validation Messages

Type: array

Title: Validation Messages

The validation messages resource provides a list of validation messages associated with a cart.

Show Source

• Array of: object carts-scheduledCourseItems-validationMessages-item-response

{
    "title":"Validation Messages",
    "type":"array",
    "description":"The validation messages resource provides a list of validation messages associated with a cart.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-validationMessages-item-response"
    }
}

Nested Schema : carts-scheduledCourseItems-courseFees-item-response

Type: object

Show Source

• courseDiscounts: array Course Discounts
  Title: Course Discounts

  The course discounts resource provides a list of discounts associated with a course.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The unique identifier of the flat amount charge of a course.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The denomination of the flat amount charge of a course.
• DiscountAmount: number
  Title: Discount Amount

  Read Only: true

  The numeric value of the discount amount given for a course.
• FeeAttributeId: integer (int64)
  Title: Fee Attribute ID

  Read Only: true

  The unique identifier of the fee attribute of the course.
• FeeAttributeTransactionDescription: string
  Title: Fee Attribute Transaction Description

  Read Only: true

  Maximum Length: 100

  The description of the fee attribute of the course.
• FeeId: integer (int64)
  Title: Fee ID

  Read Only: true

  The unique identifier of the fee of the course.
• FeeTypeCode: string
  Title: Fee Type Code

  Read Only: true

  Maximum Length: 30

  The code of the fee type of the course.
• FeeTypeId: integer (int64)
  Title: Fee Type ID

  Read Only: true

  The unique identifier of the fee type of the course.
• FlatAmount: number
  Title: Amount

  Read Only: true

  The numeric value of the flat amount charge of a course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the flat amount charge of a course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The denomination of the flat amount charge of a course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"The numeric value of the discount amount given for a course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "FeeAttributeId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the fee attribute of the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeAttributeTransactionDescription":{
            "title":"Fee Attribute Transaction Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the fee attribute of the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"The unique identifier of the fee of the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the fee type of the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeTypeId":{
            "title":"Fee Type ID",
            "type":"integer",
            "description":"The unique identifier of the fee type of the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The numeric value of the flat amount charge of a course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "courseDiscounts":{
            "title":"Course Discounts",
            "type":"array",
            "description":"The course discounts resource provides a list of discounts associated with a course.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-courseFees-courseDiscounts-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Course Discounts

Type: array

Title: Course Discounts

The course discounts resource provides a list of discounts associated with a course.

Show Source

• Array of: object carts-scheduledCourseItems-courseFees-courseDiscounts-item-response

{
    "title":"Course Discounts",
    "type":"array",
    "description":"The course discounts resource provides a list of discounts associated with a course.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-courseFees-courseDiscounts-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 : carts-scheduledCourseItems-courseFees-courseDiscounts-item-response

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 80

  Currency code for a discount applied to a course.
• CurrencySymbol: string
  Title: Currency Symbol

  Maximum Length: 80

  Currency symbol for a discount applied to a course.
• DiscountAmount: number
  Title: Discount Amount

  Amount deducted from the original cost of a course.
• DiscountName: string
  Title: Discount Name

  Maximum Length: 80

  Name of a discount applied to a course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":80,
            "type":"string",
            "description":"Currency code for a discount applied to a course.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":80,
            "type":"string",
            "description":"Currency symbol for a discount applied to a course.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"Amount deducted from the original cost of a course.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountName":{
            "title":"Discount Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of a discount applied to a course.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : carts-scheduledCourseItems-courseRequisites-item-response

Type: object

Show Source

• CourseCurriculumId: integer (int64)
  Title: Course Curriculum ID

  Read Only: true

  The unique identifier for a requisite curriculum item.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The code of the curriculum type of the requisite associated with the course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrerequisiteStatusCode: string
  Title: Prerequisite Status Code

  The code of the status of the requisite associated with the course.
• PrerequisiteStatusMeaning: string
  Title: Prerequisite Status Meaning

  The meaning of the status of the requisite associated with the course.
• RequisiteCurriculumId: integer (int64)
  Title: Requisite Curriculum ID

  Read Only: true

  The unique identifier for the curriculum requisite.
• RequisiteCurriculumName: string
  Title: Requisite Curriculum Name

  Read Only: true

  The name of a requisite curriculum item.
• RequisiteTypeCode: string
  Title: Requisite Type Code

  Read Only: true

  Maximum Length: 30

  A code that indicates the type of requisite. Valid values include ORA_CO or ORA_PRE. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "CourseCurriculumId":{
            "title":"Course Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a requisite curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the curriculum type of the requisite associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrerequisiteStatusCode":{
            "title":"Prerequisite Status Code",
            "type":"string",
            "description":"The code of the status of the requisite associated with the course.",
            "nullable":true,
            "x-queryable":true
        },
        "PrerequisiteStatusMeaning":{
            "title":"Prerequisite Status Meaning",
            "type":"string",
            "description":"The meaning of the status of the requisite associated with the course.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrerequisiteStatusCode"
                ]
            },
            "x-queryable":true
        },
        "RequisiteCurriculumId":{
            "title":"Requisite Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum requisite.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisiteCurriculumName":{
            "title":"Requisite Curriculum Name",
            "type":"string",
            "description":"The name of a requisite curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteTypeCode":{
            "title":"Requisite Type Code",
            "maxLength":30,
            "type":"string",
            "description":"A code that indicates the type of requisite. Valid values include ORA_CO or ORA_PRE. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : carts-scheduledCourseItems-scheduledCourseFees-item-response

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The unique identifier of the flat amount charge of a scheduled course.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The denomination of the flat amount charge of a scheduled course.
• DiscountAmount: number
  Title: Discount Amount

  Read Only: true

  The numeric value of the discount amount given for a scheduled course.
• FeeAttributeId: integer (int64)
  Title: Fee Attribute ID

  Read Only: true

  The unique identifier of the fee attribute of the scheduled course.
• FeeAttributeTransactionDescription: string
  Title: Fee Attribute Transaction Description

  Read Only: true

  Maximum Length: 100

  The description of the fee attribute of the scheduled course.
• FeeId: integer (int64)
  Title: Fee ID

  Read Only: true

  The unique identifier of the fee of the scheduled course.
• FeeTypeCode: string
  Title: Fee Type Code

  Read Only: true

  Maximum Length: 30

  The code of the fee type of the scheduled course.
• FeeTypeId: integer (int64)
  Title: Fee Type ID

  Read Only: true

  The unique identifier of the fee type of the scheduled course.
• FlatAmount: number
  Title: Amount

  Read Only: true

  The numeric value of the flat amount charge of a scheduled course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• scheduledCourseDiscounts: array Scheduled Course Discounts
  Title: Scheduled Course Discounts

  The scheduled course discounts resource provides a list of discounts associated with a scheduled course.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the flat amount charge of a scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The denomination of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"The numeric value of the discount amount given for a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "FeeAttributeId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the fee attribute of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeAttributeTransactionDescription":{
            "title":"Fee Attribute Transaction Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the fee attribute of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"The unique identifier of the fee of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the fee type of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeTypeId":{
            "title":"Fee Type ID",
            "type":"integer",
            "description":"The unique identifier of the fee type of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The numeric value of the flat amount charge of a scheduled course.",
            "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"
            }
        },
        "scheduledCourseDiscounts":{
            "title":"Scheduled Course Discounts",
            "type":"array",
            "description":"The scheduled course discounts resource provides a list of discounts associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourseFees-scheduledCourseDiscounts-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 : Scheduled Course Discounts

Type: array

Title: Scheduled Course Discounts

The scheduled course discounts resource provides a list of discounts associated with a scheduled course.

Show Source

• Array of: object carts-scheduledCourseItems-scheduledCourseFees-scheduledCourseDiscounts-item-response

{
    "title":"Scheduled Course Discounts",
    "type":"array",
    "description":"The scheduled course discounts resource provides a list of discounts associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourseFees-scheduledCourseDiscounts-item-response"
    }
}

Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-scheduledCourseDiscounts-item-response

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 80

  Currency code for a discount applied to a course section.
• CurrencySymbol: string
  Title: Currency Symbol

  Maximum Length: 80

  Currency symbol for a discount applied to a course section.
• DiscountAmount: number
  Title: Discount Amount

  Amount deducted from the original cost of a course section.
• DiscountName: string
  Title: Discount Name

  Maximum Length: 80

  Name of a discount applied to a course section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":80,
            "type":"string",
            "description":"Currency code for a discount applied to a course section.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":80,
            "type":"string",
            "description":"Currency symbol for a discount applied to a course section.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"Amount deducted from the original cost of a course section.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountName":{
            "title":"Discount Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of a discount applied to a course section.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : carts-scheduledCourseItems-scheduledCourses-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level value that's associated with a course.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level, such as undergraduate, that's associated with a course.
• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The unique identifier of the academic organization of the scheduled course.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The code for the scheduled course's academic subject.
• AcademicSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The unique identifier for the course's academic subject.
• AcademicSubjectName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the subject of the scheduled course.
• BuildingName: string
  Title: Name

  Read Only: true

  The name of the building associated with the meeting pattern of the scheduled course.
• BuildingShortCode: string
  Title: Code

  Read Only: true

  The unique identifier of the building associated with the meeting pattern of the scheduled course.
• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  The unique identifier for the campus where a course is offered.
• CampusName: string
  Title: Campus

  Read Only: true

  Maximum Length: 50

  The campus where the scheduled course is offered.
• ConsentTypeCode: string
  Title: Permission Type

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_NOT_REQUIRED

  The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.
• ConsentTypeMeaning: string
  Title: Consent Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
• CoursePayToEnrollFlag: boolean
  Title: Pay to enroll

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the student must pay for the course at the time of enrollment. The default value is false.
• CredentialId: integer (int64)
  Title: Scheduled Course Credential ID

  Read Only: true

  The unique identifier of the credential associated with the course.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the scheduled course.
• CredentialTypeCode: string
  Title: Credential Type

  Read Only: true

  Maximum Length: 30

  The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE.
• CreditTypeCode: string
  Title: Type of Credit

  Read Only: true

  Maximum Length: 30

  The code for the type of credit associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CreditTypeMeaning: string
  Title: Type of Credit Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number of the scheduled course.
• CurriculumFormatCode: string
  Title: Format

  Read Only: true

  Maximum Length: 30

  The code for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumFormatMeaning: string
  Title: Curriculum Format Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the format of the scheduled course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumHeaderId: integer (int64)
  Title: Curriculum Header ID

  Read Only: true

  The unique identifier for a curriculum header record.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated unique identifier of a scheduled course.
• CurriculumLongDescription: string
  Title: Long Description

  Read Only: true

  The description of the scheduled course.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the scheduled course.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title of the scheduled course.
• EnrollConsentRequiredFlag: boolean
  Title: Permission Required to Enroll

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.
• EnrollmentCapacityQuantity: integer (int32)
  Title: Enrollment Capacity

  Read Only: true

  A numeric value indicating the enrollment capacity of the scheduled course.
• EnrollmentStatusCode: string
  Title: Enrollment Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_OPN

  The unique identifier of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.
• EnrollmentStatusMeaning: string
  Title: Enrollment Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.
• FacilityDescription: string
  Title: Description

  Read Only: true

  The description of the facility associated with the scheduled course.
• FacilityRoomNumber: string
  Title: Room Number

  Read Only: true

  The room number associated with the meeting pattern of the scheduled course.
• FacilityShortCode: string
  Title: Facility

  Read Only: true

  The identifier of the facility associated with the meeting pattern of the scheduled course.
• FlatAmount: number
  Title: Flat Amount

  Read Only: true

  The numeric value of the flat amount charge of a scheduled course.
• FlatAmountCurrencyCode: string
  Title: Currency Code

  Read Only: true

  The unique identifier of the flat amount charge of a scheduled course.
• FlatAmountCurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The denomination of the flat amount charge of a scheduled course.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier for the institution where the scheduled course is offered.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution where the scheduled course is offered.
• InstructorName: string
  Title: Name

  Read Only: true

  The name of the instructor of the scheduled course.
• IsCartableFlag: boolean
  Title: Shopping Cart Enabled

  Read Only: true

  Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
• IsSchedulableFlag: boolean
  Title: Scheduler Enabled

  Read Only: true

  Indicates whether the scheduled course can be added to the scheduler. The default value is true.
• IsSelfPacedFlag: boolean
  Title: Self-Paced

  Read Only: true

  Indicates whether the scheduled course is self-paced. The default value is false.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Indicates whether the scheduled course can be added to the wish list. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationControlCode: string
  Title: Location Control Code

  Read Only: true

  The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
• LocationLatitude: number
  Title: Latitude

  Read Only: true

  The GPS latitude coordinates for the scheduled course meeting location.
• LocationLongitude: number
  Title: Longitude

  Read Only: true

  The GPS longitude coordinates for the scheduled course meeting location.
• LocationLongName: string
  Title: Location Long Name

  Read Only: true

  The name of the single use location associated with the meeting pattern of the scheduled course.
• MapIntegrationURL: string
  Title: Map Integration URL

  Read Only: true

  The uniform resource locator of the map application to be used for displaying scheduled course meeting location.
• MaximumUnitsQuantity: number
  Title: Maximum Units

  Read Only: true

  A numeric value indicating the maximum units of the scheduled course.
• MeetingPatternDescription: string
  Title: Pattern Name

  Read Only: true

  The name of the meeting pattern of the scheduled course.
• MeetingPatternEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the meeting pattern of the scheduled course ends.
• MeetingPatternEndTime: string (date-time)
  Title: End Time

  Read Only: true

  The time when the meeting pattern of the scheduled course ends.
• meetingPatterns: array Meeting Patterns
  Title: Meeting Patterns

  The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.
• MeetingPatternStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the meeting pattern of the scheduled course starts.
• MeetingPatternStartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The time when the meeting pattern of the scheduled course starts.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  A numeric value indicating the minimum units of the scheduled course.
• offeringOrganizationStaff: array Offering Organization Staff
  Title: Offering Organization Staff

  The staff associated with a curriculum item.
• OwningCurriculumId: integer (int64)
  Title: Owning Curriculum ID

  Read Only: true

  The unique identifier for the parent curriculum item of the scheduled course.
• OwningCurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name for the parent curriculum item of the scheduled course.
• OwningOfferNumber: integer (int32)
  Title: Owning Offer Number

  Read Only: true

  The unique identifier for the parent curriculum item offer number of the scheduled course.
• ReportingPeriodEndDate: string (date)
  Title: Reporting Period End Date

  Read Only: true

  The date when the reporting period associated with the scheduled course ends.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier for the reporting period associated with the scheduled course.
• ReportingPeriodName: string
  Title: Reporting Period

  Read Only: true

  Maximum Length: 50

  The name of the reporting period associated with the scheduled course.
• ReportingPeriodStartDate: string (date)
  Title: Reporting Period Start Date

  Read Only: true

  The date when the reporting period associated with the scheduled course starts.
• ScheduledCourseCode: string
  Title: Scheduled Course Code

  Read Only: true

  Maximum Length: 30

  The code used to identify a scheduled course within a given course and academic period.
• ScheduledCourseEndDate: string (date-time)
  Title: End Date

  Read Only: true

  The date when the scheduled course ends.
• ScheduledCourseNumber: integer (int32)
  Title: Scheduled Course Number

  Read Only: true

  A generated unique key for a scheduled course.
• ScheduledCourseStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The date when the scheduled course starts.
• StudentRequestConsentFlag: boolean
  Title: Allow Permission Request

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.
• TotalEnrolledQuantity: integer (int32)
  Title: Total Enrolled

  Read Only: true

  A numeric value indicating the number of enrollments in the scheduled course.
• URLAddress: string
  Title: URL Address

  Read Only: true

  The unique URL address of the scheduled course.

{
    "type":"object",
    "properties":{
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level value that's associated with a course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of an academic level, such as undergraduate, that's associated with a course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier of the academic organization of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the scheduled course's academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the course's academic subject.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the subject of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the building associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "type":"string",
            "description":"The unique identifier of the building associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where a course is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":50,
            "type":"string",
            "description":"The campus where the scheduled course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsentTypeCode":{
            "title":"Permission Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_NOT_REQUIRED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConsentTypeMeaning":{
            "title":"Consent Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoursePayToEnrollFlag":{
            "title":"Pay to enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the student must pay for the course at the time of enrollment. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Scheduled Course Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialTypeCode":{
            "title":"Credential Type",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of credit associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "maxLength":30,
            "type":"string",
            "description":"The code for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatMeaning":{
            "title":"Curriculum Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the format of the scheduled course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum header record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated unique identifier of a scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"The title of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollConsentRequiredFlag":{
            "title":"Permission Required to Enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "EnrollmentCapacityQuantity":{
            "title":"Enrollment Capacity",
            "type":"integer",
            "description":"A numeric value indicating the enrollment capacity of the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EnrollmentStatusCode":{
            "title":"Enrollment Status",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_OPN",
            "x-queryable":true
        },
        "EnrollmentStatusMeaning":{
            "title":"Enrollment Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the facility associated with the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "type":"string",
            "description":"The room number associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "type":"string",
            "description":"The identifier of the facility associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Flat Amount",
            "type":"number",
            "description":"The numeric value of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "FlatAmountCurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The unique identifier of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmountCurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The denomination of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for the institution where the scheduled course is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution where the scheduled course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructorName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the instructor of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCartableFlag":{
            "title":"Shopping Cart Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the shopping cart. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CartEnabledFlag"
                ]
            },
            "x-queryable":true
        },
        "IsSchedulableFlag":{
            "title":"Scheduler Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the scheduler. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSelfPacedFlag":{
            "title":"Self-Paced",
            "type":"boolean",
            "description":"Indicates whether the scheduled course is self-paced. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the wish list. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationControlCode":{
            "title":"Location Control Code",
            "type":"string",
            "description":"The unique identifier of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The GPS latitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"The name of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The GPS longitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "MapIntegrationURL":{
            "title":"Map Integration URL",
            "type":"string",
            "description":"The uniform resource locator of the map application to be used for displaying scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"A numeric value indicating the maximum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "type":"string",
            "description":"The name of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"A numeric value indicating the minimum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Owning Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item of the scheduled course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OwningCurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name for the parent curriculum item of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningOfferNumber":{
            "title":"Owning Offer Number",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item offer number of the scheduled course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ReportingPeriodEndDate":{
            "title":"Reporting Period End Date",
            "type":"string",
            "description":"The date when the reporting period associated with the scheduled course ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier for the reporting period associated with the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "title":"Reporting Period Start Date",
            "type":"string",
            "description":"The date when the reporting period associated with the scheduled course starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "title":"Scheduled Course Code",
            "maxLength":30,
            "type":"string",
            "description":"The code used to identify a scheduled course within a given course and academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseNumber":{
            "title":"Scheduled Course Number",
            "type":"integer",
            "description":"A generated unique key for a scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ScheduledCourseStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StudentRequestConsentFlag":{
            "title":"Allow Permission Request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "TotalEnrolledQuantity":{
            "title":"Total Enrolled",
            "type":"integer",
            "description":"A numeric value indicating the number of enrollments in the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "URLAddress":{
            "title":"URL Address",
            "type":"string",
            "description":"The unique URL address of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "meetingPatterns":{
            "title":"Meeting Patterns",
            "type":"array",
            "description":"The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response"
            }
        },
        "offeringOrganizationStaff":{
            "title":"Offering Organization Staff",
            "type":"array",
            "description":"The staff associated with a curriculum item.",
            "items":{
                "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-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 : Meeting Patterns

Type: array

Title: Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.

Show Source

• Array of: object carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response

{
    "title":"Meeting Patterns",
    "type":"array",
    "description":"The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response"
    }
}

Nested Schema : Offering Organization Staff

Type: array

Title: Offering Organization Staff

The staff associated with a curriculum item.

Show Source

• Array of: object carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-response

{
    "title":"Offering Organization Staff",
    "type":"array",
    "description":"The staff associated with a curriculum item.",
    "items":{
        "$ref":"#/components/schemas/carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-response"
    }
}

Nested Schema : carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response

Type: object

Show Source

• BuildingName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the building associated with the meeting pattern of the scheduled course.
• BuildingShortCode: string
  Title: Code

  Read Only: true

  Maximum Length: 6

  The unique identifier of the building associated with the meeting pattern of the scheduled course.
• CurriculumScheduleId: integer (int64)
  Title: Schedule ID

  Read Only: true

  The generated primary key column for a meeting pattern of the scheduled course.
• DurationQuantity: integer (int32)
  Title: Duration

  Read Only: true

  The numeric value that indicates the length of a meeting of the scheduled course.
• FacilityDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the meeting pattern of the scheduled course.
• FacilityRoomNumber: string
  Title: Room Number

  Read Only: true

  Maximum Length: 10

  The room number associated with the meeting pattern of the scheduled course.
• FacilityShortCode: string
  Title: Facility

  Read Only: true

  Maximum Length: 20

  The identifier of the facility associated with the meeting pattern of the scheduled course.
• InstructionalMethodCode: string
  Title: Instructional Method Code

  Read Only: true

  Maximum Length: 30

  The instructional method code of the meeting.
• InstructionalMethodMeaning: string
  Title: Instructional Method

  Read Only: true

  Maximum Length: 80

  The instructional method meaning of the meeting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationControlCode: string
  Title: Location Control Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_USE_FACILITY

  The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
• LocationLatitude: number
  Title: Latitude

  Read Only: true

  The GPS latitude coordinates for the scheduled course meeting location.
• LocationLongitude: number
  Title: Longitude

  Read Only: true

  The GPS longitude coordinates for the scheduled course meeting location.
• LocationLongName: string
  Title: Location Long Name

  Read Only: true

  The name of the single use location associated with the meeting pattern of the scheduled course.
• MeetingPatternDescription: string
  Title: Pattern Name

  Read Only: true

  Maximum Length: 50

  The name of the meeting pattern of the scheduled course.
• MeetingPatternEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the meeting pattern of the scheduled course ends.
• MeetingPatternEndTime: string (date-time)
  Title: End Time

  Read Only: true

  The time when the meeting pattern of the scheduled course ends.
• MeetingPatternName: string
  Title: Meeting Name

  Read Only: true

  Maximum Length: 50

  The meeting name of the course scheduled in the facility.
• MeetingPatternStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the meeting pattern of the scheduled course starts.
• MeetingPatternStartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The time when the meeting pattern of the scheduled course starts.
• RecurrenceDayFriFlag: boolean
  Title: Friday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Friday.
• RecurrenceDayMonFlag: boolean
  Title: Monday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Monday.
• RecurrenceDaySatFlag: boolean
  Title: Saturday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Saturday.
• RecurrenceDaySunFlag: boolean
  Title: Sunday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Sunday.
• RecurrenceDayThuFlag: boolean
  Title: Thursday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Thursday.
• RecurrenceDayTueFlag: boolean
  Title: Tuesday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Tuesday.
• RecurrenceDayWedFlag: boolean
  Title: Wednesday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Wednesday.
• ScheduleSequenceNumber: integer (int32)
  Title: Schedule Sequence Number

  Read Only: true

  The sequence identifier of the meeting pattern of the scheduled course.

{
    "type":"object",
    "properties":{
        "BuildingName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the building associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "maxLength":6,
            "type":"string",
            "description":"The unique identifier of the building associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"The generated primary key column for a meeting pattern of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DurationQuantity":{
            "title":"Duration",
            "type":"integer",
            "description":"The numeric value that indicates the length of a meeting of the scheduled course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "maxLength":10,
            "type":"string",
            "description":"The room number associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the facility associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionalMethodCode":{
            "title":"Instructional Method Code",
            "maxLength":30,
            "type":"string",
            "description":"The instructional method code of the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionalMethodMeaning":{
            "title":"Instructional Method",
            "maxLength":80,
            "type":"string",
            "description":"The instructional method meaning of the meeting.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationControlCode":{
            "title":"Location Control Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_USE_FACILITY",
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The GPS latitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"The name of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The GPS longitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternName":{
            "title":"Meeting Name",
            "maxLength":50,
            "type":"string",
            "description":"The meeting name of the course scheduled in the facility.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"TimeFrom-TimeTo",
                "customLinks":"true",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"80",
                "facetControl":"timeRange",
                "title":"Start Date",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayFriFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Friday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Friday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnFri",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Monday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Monday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnMon",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDaySatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Saturday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Saturday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnSat",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDaySunFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Sunday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Sunday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnSun",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Thursday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Thursday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnThu",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Tuesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Tuesday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnTue",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Wednesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Wednesday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnWed",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "ScheduleSequenceNumber":{
            "title":"Schedule Sequence Number",
            "type":"integer",
            "description":"The sequence identifier of the meeting pattern of the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-response

Type: object

Show Source

• CurriculumStaffId: integer (int64)
  Title: Curriculum Staff ID

  Read Only: true

  The generated primary key column for a curriculum staff record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonAcademicTitle: string
  Title: Academic Title

  Read Only: true

  Maximum Length: 30

  The academic title of the staff member associated with the curriculum item.
• PersonImageContent: string (byte)
  Title: Staff Image

  Read Only: true

  The content of a staff attachment such as an image file.
• PersonImageId: integer (int64)
  Title: Attachment ID

  Read Only: true

  A unique identifier for an attachment associated with a curriculum item.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 450

  The name of the staff member associated with the curriculum item.
• PersonTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title of the staff member associated with the curriculum item.
• StaffBiography: string
  Title: Biography

  Read Only: true

  The text providing biographical or background information on a staff member.
• StaffPrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 1

  Identifies the primary staff member for a curriculum item. When yes, the staff row is considered the primary staff resource for the curriculum item. The default value is false. If only one record exists, the default value is true.
• StaffRoleTypeCode: string
  Title: Role Type

  Read Only: true

  Maximum Length: 30

  The role type of the staff member associated with the curriculum item. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• StaffRoleTypeMeaning: string
  Title: Role Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the role type of the staff member associated with the curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• StaffSequenceNumber: integer (int32)
  Title: Staff Sequence Number

  Read Only: true

  The sequence number of a staff row associated with a curriculum item.

{
    "type":"object",
    "properties":{
        "CurriculumStaffId":{
            "title":"Curriculum Staff ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum staff record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PersonAcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The academic title of the staff member associated with the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageContent":{
            "title":"Staff Image",
            "type":"string",
            "description":"The content of a staff attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"A unique identifier for an attachment associated with a curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the staff member associated with the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the staff member associated with the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffBiography":{
            "title":"Biography",
            "type":"string",
            "description":"The text providing biographical or background information on a staff member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary staff member for a curriculum item. When yes, the staff row is considered the primary staff resource for the curriculum item. The default value is false. If only one record exists, the default value is true.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeCode":{
            "title":"Role Type",
            "maxLength":30,
            "type":"string",
            "description":"The role type of the staff member associated with the curriculum item. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeMeaning":{
            "title":"Role Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the role type of the staff member associated with the curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffSequenceNumber":{
            "title":"Staff Sequence Number",
            "type":"integer",
            "description":"The sequence number of a staff row associated with a curriculum item.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : carts-scheduledCourseItems-validationMessages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Title: Cart Message ID

  The unique identifier for the validation message.
• ValidationCode: string
  Title: Cart Validation Code

  Read Only: true

  Maximum Length: 30

  The code for the validation message.
• ValidationDescription: string
  Title: Cart Validation Message

  Read Only: true

  The description for the validation message.
• ValidationSeverity: string
  Title: Cart Validation Severity

  Read Only: true

  The severity for the validation message.

{
    "type":"object",
    "properties":{
        "MessageId":{
            "title":"Cart Message ID",
            "type":"integer",
            "description":"The unique identifier for the validation message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValidationCode":{
            "title":"Cart Validation Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the validation message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationDescription":{
            "title":"Cart Validation Message",
            "type":"string",
            "description":"The description for the validation message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationSeverity":{
            "title":"Cart Validation Severity",
            "type":"string",
            "description":"The severity for the validation message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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