Jump to

• Request
• Response

Update a course selection

patch

/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections/{CourseSelectionId}

Request

Path Parameters

• ApplicationId(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=
• CourseSelectionId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  The curriculum identifier for the selected course.
• CourseListCurriculumId: integer (int64)
  Title: Course List Curriculum ID

  The curriculum identifier for the course list of the selected course.
• CourseListSequence: integer (int32)
  Title: Course List Sequence

  Default Value: 1

  The sequence of the course list for the associated course selection.
• CoursePreference: integer (int32)
  Title: Course Preference

  Default Value: 1

  Course selection preference sequence number.
• ProgramCurriculumId: integer (int64)
  Title: Program Curriculum ID

  The curriculum identifier for the program of the selected course.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• SelectionDateTime: string (date-time)
  Title: Selection Date

  The date of the course selection.

{
    "type":"object",
    "properties":{
        "ProgramCurriculumId":{
            "title":"Program Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the program of the selected course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "CourseListSequence":{
            "title":"Course List Sequence",
            "type":"integer",
            "description":"The sequence of the course list for the associated course selection.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"9"
            }
        },
        "CourseListCurriculumId":{
            "title":"Course List Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the course list of the selected course.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoursePreference":{
            "title":"Course Preference",
            "type":"integer",
            "description":"Course selection preference sequence number.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"9"
            }
        },
        "SelectionDateTime":{
            "title":"Selection Date",
            "type":"string",
            "description":"The date of the course selection.",
            "format":"date-time",
            "nullable":false
        },
        "CourseCurriculumId":{
            "title":"Course Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the selected course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : admissionApplications-courseSelections-item-response

Type: object

Show Source

• CatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number of the course selection.
• CourseCurriculumId: integer (int64)
  Title: Course Curriculum ID

  The curriculum identifier for the selected course.
• CourseDescription: string (byte)
  Title: Description

  Read Only: true

  The description of the selected course.
• CourseListCurriculumId: integer (int64)
  Title: Course List Curriculum ID

  The curriculum identifier for the course list of the selected course.
• CourseListName: string
  Title: Course List Name

  Read Only: true

  Maximum Length: 50

  The name for the course list of the selected course.
• CourseListSequence: integer (int32)
  Title: Course List Sequence

  Default Value: 1

  The sequence of the course list for the associated course selection.
• CourseListTitle: string
  Title: Course List Title

  Read Only: true

  Maximum Length: 100

  The title for the course list of the selected course.
• CourseName: string
  Title: Course Name

  Read Only: true

  Maximum Length: 50

  The name of the selected course.
• CoursePreference: integer (int32)
  Title: Course Preference

  Default Value: 1

  Course selection preference sequence number.
• CourseSelectionId: integer (int64)
  Title: Course Selection ID

  Read Only: true

  Unique identifier for the course selection.
• CourseTitle: string
  Title: Course Title

  Read Only: true

  Maximum Length: 100

  The title of the selected course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramCurriculumId: integer (int64)
  Title: Program Curriculum ID

  The curriculum identifier for the program of the selected course.
• ProgramName: string
  Title: Program Name

  Read Only: true

  Maximum Length: 50

  The name for the academic program of the selected course.
• ProgramTitle: string
  Title: Program Title

  Read Only: true

  Maximum Length: 100

  The title for the academic program of the selected course.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• SelectionDateTime: string (date-time)
  Title: Selection Date

  The date of the course selection.
• Subject: string
  Title: Subject

  Read Only: true

  Maximum Length: 50

  The subject of the course selection.
• SubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The subject code of the course selection.

{
    "type":"object",
    "properties":{
        "CourseName":{
            "title":"Course Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCurriculumId":{
            "title":"Program Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the program of the selected course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "CourseListSequence":{
            "title":"Course List Sequence",
            "type":"integer",
            "description":"The sequence of the course list for the associated course selection.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CourseListCurriculumId":{
            "title":"Course List Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the course list of the selected course.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CourseListName":{
            "title":"Course List Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name for the course list of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoursePreference":{
            "title":"Course Preference",
            "type":"integer",
            "description":"Course selection preference sequence number.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CourseTitle":{
            "title":"Course Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name for the academic program of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"50",
            "type":"string",
            "description":"The subject of the course selection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseSelectionId":{
            "title":"Course Selection ID",
            "type":"integer",
            "description":"Unique identifier for the course selection.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CourseDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the selected course.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CatalogNumber":{
            "title":"Catalog Number",
            "maxLength":"10",
            "type":"string",
            "description":"The catalog number of the course selection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectCode":{
            "title":"Subject Code",
            "maxLength":"30",
            "type":"string",
            "description":"The subject code of the course selection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseListTitle":{
            "title":"Course List Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title for the course list of the selected 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"
            }
        },
        "SelectionDateTime":{
            "title":"Selection Date",
            "type":"string",
            "description":"The date of the course selection.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramTitle":{
            "title":"Program Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title for the academic program of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseCurriculumId":{
            "title":"Course Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the selected course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top