Get a hearing body
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies/{publicSectorHearingBodiesUniqID}
Request
Path Parameters
-
publicSectorHearingBodiesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and HearingBodyCode ---for the Hearing Bodies resource and used to uniquely identify an instance of Hearing Bodies. The client should not generate the hash key value. Instead, the client should query on the Hearing Bodies collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Bodies.
For example: publicSectorHearingBodies?q=AgencyId=<value1>;HearingBodyCode=<value2>
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 : publicSectorHearingBodies-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The address line 1 of the public hearing location. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The address line 2 of the public hearing location. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The address line 3 of the public hearing location. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The address line 4 of the public hearing location. -
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the agency. -
AppealPeriod(optional):
integer(int32)
Title:
Appeal PeriodThe number of days after the hearing during which an appeal is allowed. -
CityName(optional):
string
Title:
CityMaximum Length:60The city in which the public hearing is scheduled. -
Classification(optional):
string
Maximum Length:
10The classification of the hearing body . -
CountryCode(optional):
string
Title:
CountryMaximum Length:3The country code of the public hearing location. -
CountyCodeIncits(optional):
string
Title:
CountyMaximum Length:60The county in which the public hearing is scheduled. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the hearing body row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the hearing body row was created. -
DayRecurrences(optional):
array Hearing Body Day Recurrences
Title:
Hearing Body Day RecurrencesThe hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting. -
Description(optional):
string
Title:
Additional InformationMaximum Length:800The description of the hearing body. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates if the hearing body is available to use. -
ExpirationPeriod(optional):
integer(int32)
Title:
Expiration PeriodThe number of days after the hearing when the hearing schedule expires. -
FridayFlag(optional):
boolean
The hearing body meeting recurrence option for Friday.
-
HearingBodyCode(optional):
string
Title:
Hearing Body CodeMaximum Length:60The unique identifier of the hearing body. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the hearing body row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who updated the hearing body row. -
links(optional):
array Items
Title:
ItemsLink Relations -
MaximumAgendaItems(optional):
integer(int32)
Title:
Maximum Agenda ItemsThe maximum number of agenda items that can be heard on a day. -
MondayFlag(optional):
boolean
The hearing body meeting recurrence option for Monday.
-
MonthRecurOption(optional):
string
Title:
Months Between OccurrencesMaximum Length:15The frequency in months within which the hearing body meets. -
Name(optional):
string
Title:
NameMaximum Length:200The name of the hearing body. -
NotificationPeriod(optional):
integer(int32)
Title:
Reminder Notification PeriodThe hearing body notification period. -
PostalPlus4Code(optional):
string
Maximum Length:
10The postal code of the location in which the public hearing is scheduled. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province in which the public hearing is scheduled. -
RecurFrequency(optional):
integer(int32)
Title:
Weeks Between OccurrencesThe frequency in weeks within which the hearing body meets. -
RecurrenceOption(optional):
string
Title:
Recurrence PatternMaximum Length:15The recurrence of the hearing meetings of the hearing body. -
SaturdayFlag(optional):
boolean
The hearing body meeting recurrence option for Saturday.
-
StartDatetime(optional):
string(date-time)
Title:
Recurrence Start Date TimeThe start date and time of the meeting recurrence. -
StateCodeISO(optional):
string
Title:
StateMaximum Length:60The state in which the public hearing is scheduled. -
SundayFlag(optional):
boolean
The hearing body meeting recurrence option for Sunday.
-
ThursdayFlag(optional):
boolean
The hearing body meeting recurrence option for Thursday.
-
TuesdayFlag(optional):
boolean
The hearing body meeting recurrence option for Tuesday.
-
WednesdayFlag(optional):
boolean
The hearing body meeting recurrence option for Wednesday.
-
WeekRecurrences(optional):
array Hearing Body Week Recurrences
Title:
Hearing Body Week RecurrencesThe hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting. -
ZipCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the public hearing location.
Nested Schema : Hearing Body Day Recurrences
Type:
arrayTitle:
Hearing Body Day RecurrencesThe hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.
Show Source
Nested Schema : Hearing Body Week Recurrences
Type:
arrayTitle:
Hearing Body Week RecurrencesThe hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting.
Show Source
Nested Schema : publicSectorHearingBodies-DayRecurrences-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe agency ID of the record. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates whether the hearing body day recurrence is available to use. -
HearingBodyCode(optional):
string
Title:
Hearing Body CodeMaximum Length:60The hearing body code of the record. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
links(optional):
array Items
Title:
ItemsLink Relations -
Occurrence(optional):
integer(int32)
Title:
DateThe dates of the month when the hearing body meets. For example, 2,30.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorHearingBodies-WeekRecurrences-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the agency. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates if the hearing body week recurrence is available to use. -
HearingBodyCode(optional):
string
Title:
Hearing Body CodeMaximum Length:60The unique identifier of the hearing body. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
links(optional):
array Items
Title:
ItemsLink Relations -
Occurrence(optional):
string
Title:
OccurrenceMaximum Length:15The recurrence frequency of the hearing body meeting in a month. For example First Monday, Second Wednesday. -
WeekDay(optional):
string
Title:
WeekdayMaximum Length:15The day of the week when the hearing body meeting is scheduled. For example Monday, Tuesday.