Get a Pre-application meeting setup attribute
get
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs/{publicSectorPreappMeetingConfigsUniqID}
Request
Path Parameters
-
publicSectorPreappMeetingConfigsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, Classification and PreappType ---for the Pre-Application Meeting Configurations resource and used to uniquely identify an instance of Pre-Application Meeting Configurations. The client should not generate the hash key value. Instead, the client should query on the Pre-Application Meeting Configurations collection resource with a filter on the primary key values in order to navigate to a specific instance of Pre-Application Meeting Configurations.
For example: publicSectorPreappMeetingConfigs?q=AgencyId=<value1>;Classification=<value2>;PreappType=<value3>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPreappMeetingConfigs-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier of the public sector agency.
-
ApplicantReschedule(optional):
string
Title:
Applicant can reschedule and cancel
Maximum Length:1
The identifier to indicate if an applicant can reschedule or cancel a meeting. -
ApplicantSchedule(optional):
string
Title:
Applicant can request
Maximum Length:1
The identifier to indicate if an applicant can schedule a meeting. -
Classification(optional):
string
Maximum Length:
3
The identifier indicates that the setup being configured is for the Consultation or Pre-Application. -
IncludeAgenda(optional):
string
Title:
Include Agenda
Maximum Length:1
Indicates if the meeting agenda should be shown in schedule meetings page. -
IncludeVenue(optional):
string
Title:
Include Location
Maximum Length:1
Indicates if the meeting location should be shown in schedule meetings page. -
links(optional):
array Items
Title:
Items
Link Relations -
MaxMeetingConcurrency(optional):
integer(int32)
Title:
Maximum Concurrent Meetings
The identifier of the maximum number of meetings that can be conducted in parallel for a given period within the agency. -
Meaning(optional):
string
Maximum Length:
80
The description of the classification. -
MeetingAgenda(optional):
string
Title:
Meeting Agenda
Maximum Length:4000
The description of the meeting agenda. -
MeetingDurationHours(optional):
number
Title:
Meeting Duration in Hours
The identifier of the estimated duration of a meeting. -
MeetingVenue(optional):
string
Title:
Meeting Location
Maximum Length:2000
The description of the meeting venue. -
PreappType(optional):
string
Maximum Length:
30
The identifier of the application type. -
PreappWorkschedule(optional):
string
Title:
Pre-application Work Schedule
Maximum Length:30
The identifier to indicate the work schedule that will be used by the agency for the meeting configuration. -
ScheduleUptoDays(optional):
integer(int32)
Title:
Schedule up to Number of Days
The identifier of the number of days to display on the calendar for scheduling the meeting. -
StartOfWindow(optional):
integer(int32)
Title:
Schedule After Number of Days
The identifier to indicate the number of days in advance after which the meeting can be configured. -
UseScheduleAgency(optional):
string
Title:
Agency meeting schedule
Maximum Length:1
The identifier to indicate if an agency work schedule is to be used for configuration. -
UseSchedulePlanner(optional):
string
Title:
Planner meeting schedule
Maximum Length:1
The identifier to indicate if planners work schedule is to be used for the configuration.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.