Jump to

• Request
• Response

Get a cart as logged-in user

get

/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/carts/{CartHeaderId}

Request

Path Parameters

• CartHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• transactionReferenceContextsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Transaction Reference Contexts resource and used to uniquely identify an instance of Transaction Reference Contexts. The client should not generate the hash key value. Instead, the client should query on the Transaction Reference Contexts collection resource in order to navigate to a specific instance of Transaction Reference Contexts to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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 : transactionReferenceContexts-carts-item-response

Type: object

Show Source

• CartHeaderId: integer (int64)
  Title: Cart Header ID

  Read Only: true

  The unique identifier of the shopping cart header.
• CountryCode: string
  A short alphabetic code representing the country that's used as the default address.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The currency code associated with a cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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/transactionReferenceContexts-carts-scheduledCourseItems-item-response"
            }
        },
        "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
        },
        "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
        },
        "PromotionCode":{
            "title":"Promotion Code",
            "type":"string",
            "description":"The promotion code applied to 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"
            }
        },
        "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
        },
        "CountryCode":{
            "type":"string",
            "description":"A short alphabetic code representing the country that's used as the default address.",
            "nullable":true,
            "x-queryable":true
        },
        "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/transactionReferenceContexts-carts-miscellaneousFeeItems-item-response"
            }
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The currency symbol associated with a cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : 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 transactionReferenceContexts-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/transactionReferenceContexts-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 transactionReferenceContexts-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/transactionReferenceContexts-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 : transactionReferenceContexts-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.
• 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.
• 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.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "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
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with a miscellaneous fee.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        }
    }
}

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 : transactionReferenceContexts-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.
• 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.
• GradingOptionName: string
  Title: Grading Option Name

  Read Only: true

  The name for the grading option of a scheduled course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwningCurriculumName: string
  Title: Owning Name

  Read Only: true

  Maximum Length: 50

  The unique identifier of the parent curriculum item.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "OwningCurriculumName":{
            "title":"Owning Name",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the parent curriculum item.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The currency symbol associated with a scheduled course fee.",
            "nullable":true,
            "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
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The currency code associated with a scheduled course fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "SelfPacedClassStartDate":{
            "title":"Self-Paced Start Date",
            "type":"string",
            "description":"The start date of self paced classes.",
            "format":"date",
            "nullable":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"
    }
}

Links

miscellaneousFeeItems

Operation: /fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/carts/{CartHeaderId}/child/miscellaneousFeeItems

Parameters:

• CartHeaderId: $request.path.CartHeaderId
• transactionReferenceContextsUniqID: $request.path.transactionReferenceContextsUniqID

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

scheduledCourseItems

Operation: /fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/carts/{CartHeaderId}/child/scheduledCourseItems

Parameters:

• CartHeaderId: $request.path.CartHeaderId
• transactionReferenceContextsUniqID: $request.path.transactionReferenceContextsUniqID

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

Back to Top