Get a waitlist setting
get
/fscmRestApi/resources/11.13.18.05/waitlistSettings/{WaitlistSettingsId}
Request
Path Parameters
-
WaitlistSettingsId(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=
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : waitlistSettings-item-response
Type:
Show Source
object
-
assignments: array
Waitlist Settings Assignments
Title:
Waitlist Settings Assignments
The assignments resource is used to list the academic entities assigned to the waitlist settings. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
DefaultWaitlistCapacity: integer
(int32)
Title:
Default Waitlist Capacity
Default Value:0
The default capacity of the waitlist. -
DropWLSectionsAfterEnrollFlag: boolean
Title:
Drop Waitlisted Sections After Enrollment
Maximum Length:1
Default Value:false
Indicates that the student will be dropped from the waitlist of other sections of a course after they have successfully enrolled in any sections for that course. -
ExpiredInvitationAction: string
Title:
Expired Invitation Action
Read Only:true
Maximum Length:80
The meaning of the expired invitation action code. A list of accepted values and meanings is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION. -
ExpiredInvitationActionCode: string
Title:
Expired Invitation Action Code
Maximum Length:30
The expired invitation action code. A list of accepted values is defined in the lookup type ORA_HER_EXPIRED_INVITATION_ACTION. -
InvitationResponseHours: integer
(int32)
Title:
Invitation Response Hours
Default Value:0
The invitation response hours of the waitlist setting documenting how long a student has to respond to an open seat notification. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumControlType: string
Title:
Maximum Waitlist Control Type
Read Only:true
Maximum Length:80
The maximum waitlist control type. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE. -
MaximumControlTypeCode: string
Title:
Maximum Waitlist Control Type Code
Maximum Length:30
The maximum waitlist control type code. Used to identify units or courses as the metric controlling maximum number of waitlists a student can be on at a given time. A list of accepted values is defined in the lookup type ORA_HER_MAX_WL_CONTROL_TYPE. -
MaximumControlUnits: integer
(int32)
Title:
Maximum Waitlist Control Units
Default Value:0
The maximum number of control units that limits a student's ability to waitlist after this number is reached. -
OwningEntityCode: string
Title:
Owning Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
OwningEntityId: integer
(int64)
Title:
Owning Entity ID
The unique identifier of the owning entity. -
OwningEntityName: string
Title:
Owning Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
OwningEntitySubTypeCode: string
Title:
Owning Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
OwningEntitySubTypeMeaning: string
Title:
Owning Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
OwningEntityTypeCode: string
Title:
Owning Entity Type Code
Maximum Length:30
The entity type code of the owning entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
OwningEntityTypeMeaning: string
Title:
Owning Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
WaitlistCode: string
Title:
Waitlisting Code
Read Only:true
Maximum Length:150
The alternate unique identifier for waitlist settings. -
WaitlistingEnabledFlag: boolean
Title:
Waitlisting Enabled
Maximum Length:1
Default Value:false
Indicates that the waitlist setting is enabled. -
WaitlistSettingsId: integer
(int64)
Title:
Waitlist Settings ID
Read Only:true
The unique identifier for the waitlist settings.
Nested Schema : Waitlist Settings Assignments
Type:
array
Title:
Waitlist Settings Assignments
The assignments resource is used to list the academic entities assigned to the waitlist settings.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : waitlistSettings-assignments-item-response
Type:
Show Source
object
-
AssignedEntityCode: string
Title:
Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
AssignedEntitySubTypeCode: string
Title:
Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
AssignedEntitySubTypeMeaning: string
Title:
Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignedEntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
AssignmentMethod: string
Title:
Assignment Method
Read Only:true
Maximum Length:80
The assignment method type meaning used to indicate how waitlist settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentMethodCode: string
Title:
Assignment Method Code
Maximum Length:30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the associated entity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelatedEntityCode: string
Title:
Related Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
RelatedEntityId: integer
(int64)
Title:
Related Entity ID
The unique identifier of the related entity. -
RelatedEntityName: string
Title:
Related Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
RelatedEntitySubTypeCode: string
Title:
Related Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
RelatedEntitySubTypeMeaning: string
Title:
Related Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
RelatedEntityTypeCode: string
Title:
Related Entity Type Code
Maximum Length:30
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
RelatedEntityTypeMeaning: string
Title:
Related Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
SettingsAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Read Only:true
The unique identifier for the setup association record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ExipredInvitationActionCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_EXP_WL_INV_ACTION
The following properties are defined on the LOV link relation:- Source Attribute: ExpiredInvitationActionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MaximumControlTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_MAX_WL_CONTROL_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: MaximumControlTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OwningEntityTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: OwningEntityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- assignments
-
Operation: /fscmRestApi/resources/11.13.18.05/waitlistSettings/{WaitlistSettingsId}/child/assignmentsParameters:
- WaitlistSettingsId:
$request.path.WaitlistSettingsId
The assignments resource is used to list the academic entities assigned to the waitlist settings. - WaitlistSettingsId: