Get all hearing bodies
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodies
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the hearing body that matches the specified search criteria.
Finder Variables:- AgencyId; integer; The unique identifier of the agency.
- HearingBodyCode; string; The unique identifier of the hearing body.
- simpleSearchFinder: Finds the hearing body that matches the specified search criteria.
Finder Variables:- value; string; The hearing body name.
- PrimaryKey: Finds the hearing body that matches the specified search criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address1; string; The address line 1 of the public hearing location.
- Address2; string; The address line 2 of the public hearing location.
- Address3; string; The address line 3 of the public hearing location.
- Address4; string; The address line 4 of the public hearing location.
- AgencyId; integer; The unique identifier of the agency.
- AppealOnlyFlag; boolean; The flag to indicate whether the hearing body is an appeal only body.
- AppealPeriod; integer; The number of days after the hearing during which an appeal is allowed.
- BipTemplateId; string; The identifier for the BIP report template associated with the hearing body.
- CityName; string; The city in which the public hearing is scheduled.
- Classification; string; The classification of the hearing body .
- CountryCode; string; The country code of the public hearing location.
- CountyCodeIncits; string; The county in which the public hearing is scheduled.
- CreatedBy; string; The name of the user who created the hearing body row.
- CreationDate; string; The date and time when the hearing body row was created.
- Description; string; The description of the hearing body.
- EnabledFlag; boolean; Indicates if the hearing body is available to use.
- ExpirationPeriod; integer; The number of days after the hearing when the hearing schedule expires.
- FridayFlag; boolean; The hearing body meeting recurrence option for Friday.
- HearingBodyCode; string; The unique identifier of the hearing body.
- HearingHierarchyCode; string; The hearing hierarchy code mapped to the hearing body.
- LastUpdateDate; string; The date and time when the hearing body row was last updated.
- LastUpdatedBy; string; The name of the user who updated the hearing body row.
- MaximumAgendaItems; integer; The maximum number of agenda items that can be heard on a day.
- MondayFlag; boolean; The hearing body meeting recurrence option for Monday.
- MonthRecurOption; string; The frequency in months within which the hearing body meets.
- Name; string; The name of the hearing body.
- NotificationPeriod; integer; The hearing body notification period.
- PostalPlus4Code; string; The postal code of the location in which the public hearing is scheduled.
- Province; string; The province in which the public hearing is scheduled.
- RecurFrequency; integer; The frequency in weeks within which the hearing body meets.
- RecurrenceOption; string; The recurrence of the hearing meetings of the hearing body.
- SaturdayFlag; boolean; The hearing body meeting recurrence option for Saturday.
- StartDatetime; string; The start date and time of the meeting recurrence.
- StateCodeISO; string; The state in which the public hearing is scheduled.
- SundayFlag; boolean; The hearing body meeting recurrence option for Sunday.
- ThursdayFlag; boolean; The hearing body meeting recurrence option for Thursday.
- TuesdayFlag; boolean; The hearing body meeting recurrence option for Tuesday.
- WednesdayFlag; boolean; The hearing body meeting recurrence option for Wednesday.
- ZipCode; string; The postal code of the public hearing location.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : publicSectorHearingBodies
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorHearingBodies-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The address line 1 of the public hearing location. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The address line 2 of the public hearing location. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The address line 3 of the public hearing location. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The address line 4 of the public hearing location. -
AgencyId: integer
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
AppealOnlyFlag: boolean
Maximum Length:
1
Default Value:true
The flag to indicate whether the hearing body is an appeal only body. -
AppealPeriod: integer
Title:
Appeal Period in Days
The number of days after the hearing during which an appeal is allowed. -
BipTemplateId: string
Title:
Decision Making Body Report Template
Maximum Length:32
The identifier for the BIP report template associated with the hearing body. -
CityName: string
Title:
City
Maximum Length:60
The city in which the public hearing is scheduled. -
Classification: string
Maximum Length:
10
Default Value:ORA_PZ
The classification of the hearing body . -
CountryCode: string
Title:
Country
Maximum Length:3
The country code of the public hearing location. -
CountyCodeIncits: string
Title:
County
Maximum Length:60
The county in which the public hearing is scheduled. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the hearing body row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the hearing body row was created. -
DayRecurrences: array
Hearing Body Day Recurrences
Title:
Hearing Body Day Recurrences
The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting. -
Description: string
Title:
Additional Information
Maximum Length:800
The description of the hearing body. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates if the hearing body is available to use. -
ExpirationPeriod: integer
Title:
Expiration Period
The number of days after the hearing when the hearing schedule expires. -
FridayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Friday. -
HearingBodyCode: string
Title:
Hearing Body Code
Maximum Length:60
The unique identifier of the hearing body. -
HearingHierarchyCode: string
Maximum Length:
60
The hearing hierarchy code mapped to the hearing body. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the hearing body row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who updated the hearing body row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAgendaItems: integer
Title:
Maximum Agenda Items
The maximum number of agenda items that can be heard on a day. -
MondayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Monday. -
MonthRecurOption: string
Title:
Months Between Occurrences
Maximum Length:15
Default Value:ORA_DATE
The frequency in months within which the hearing body meets. -
Name: string
Title:
Name
Maximum Length:200
The name of the hearing body. -
NotificationPeriod: integer
Title:
Reminder Notification Period
The hearing body notification period. -
PostalPlus4Code: string
Maximum Length:
10
The postal code of the location in which the public hearing is scheduled. -
Province: string
Title:
Province
Maximum Length:60
The province in which the public hearing is scheduled. -
RecurFrequency: integer
(int32)
Title:
Weeks Between Occurrences
The frequency in weeks within which the hearing body meets. -
RecurrenceOption: string
Title:
Recurrence Pattern
Maximum Length:15
The recurrence of the hearing meetings of the hearing body. -
SaturdayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Saturday. -
StartDatetime: string
(date-time)
Title:
Recurrence Start Date Time
The start date and time of the meeting recurrence. -
StateCodeISO: string
Title:
State
Maximum Length:60
The state in which the public hearing is scheduled. -
SundayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Sunday. -
ThursdayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Thursday. -
TuesdayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Tuesday. -
WednesdayFlag: boolean
Maximum Length:
1
The hearing body meeting recurrence option for Wednesday. -
WeekRecurrences: array
Hearing Body Week Recurrences
Title:
Hearing Body Week Recurrences
The hearing body week recurrence resource is used to view, create, or modify a weekly recurrence of the hearing body meeting. -
ZipCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the public hearing location.
Nested Schema : Hearing Body Day Recurrences
Type:
array
Title:
Hearing Body Day Recurrences
The hearing body day recurrence resource is used to view, create, or modify a daily recurrence of the hearing body meeting.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Hearing Body Week Recurrences
Type:
array
Title:
Hearing Body Week Recurrences
The 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-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the hearing body day recurrence is available to use. -
HearingBodyCode: string
Title:
Hearing Body Code
Maximum Length:60
The hearing body code of the record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Occurrence: integer
(int32)
Title:
Date
The dates of the month when the hearing body meets. For example, 2, 30.
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.
Nested Schema : publicSectorHearingBodies-WeekRecurrences-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates if the hearing body week recurrence is available to use. -
HearingBodyCode: string
Title:
Hearing Body Code
Maximum Length:60
The unique identifier of the hearing body. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Occurrence: string
Title:
Occurrence
Maximum Length:15
The recurrence frequency of the hearing body meeting in a month. For example First Monday, Second Wednesday. -
WeekDay: string
Title:
Weekday
Maximum Length:15
The day of the week when the hearing body meeting is scheduled. For example Monday, Tuesday.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source