Get all scheduled hearings
get
/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings
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 scheduled hearing that matches the specified search criteria.
Finder Variables:- HearingEventKey; integer; The unique identifier of the hearing event.
- HearingKey; integer; The unique identifier of the hearing.
- HearingSequenceKey; integer; The unique identifier of the hearing sequence.
- scheduledEventsFinder: Finds the scheduled hearing that matches the specified search criteria.
Finder Variables:- hearingBodyCode; string; The hearing body code.
- scheduleEndDateTime; string; The end date and time of the hearing schedule.
- scheduleStartDateTime; string; The start date and time of the hearing schedule.
- simpleSearchFinder: Finds the scheduled hearing that matches the specified search criteria.
Finder Variables:- searchValue; string; The search value for using in the search criteria.
- PrimaryKey: Finds the scheduled hearing 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 first line for the primary parcel address of the record.
- Address2; string; The second line for the primary parcel address of the record.
- Address3; string; The third line for the primary parcel address of the record.
- Address4; string; The fourth line for the primary parcel address of the record.
- AgencyId; integer; The unique identifier of the agency.
- City; string; The city for the primary parcel address of the record.
- Classification; string; The classification of the of the planning and zoning application.
- Country; string; The country for the primary parcel address of the record.
- Description; string; The description of the planning and zoning application.
- EventDecision; string; The hearing event decision code.
- EventDecisionDatetime; string; The date and time of the hearing event decision.
- EventStatus; string; The hearing event status.
- HearingBodyCode; string; The unique identifier of the hearing body.
- HearingBodyName; string; The hearing body name.
- HearingDecisionCode; string; The hearing decision code.
- HearingDecisionName; string; The hearing decision name.
- HearingEventKey; integer; The unique identifier of the hearing event record.
- HearingHierarchyCode; string; The hearing hierarchy code of the record.
- HearingKey; integer; The unique identifier of the hearing record.
- HearingSequenceKey; integer; The unique identifier of the hearing sequence record.
- LnpRecordId; string; The unique identifier of the planning and zoning application.
- LnpRecordKey; integer; The unique identifier of the planning and zoning application.
- ParentEventKey; integer; The unique identifier of the parent hearing event.
- ParentSequenceKey; integer; The unique identifier of the parent hearing sequence.
- PermitAssignedId; integer; The unique identifier of the planner assigned to the permit.
- PersonFirstName; string; The first name of the applicant.
- PersonLastName; string; The last name of the applicant.
- PlannerName; string; The name of the planner assigned to the planning and zoning application.
- PostalCode; string; The postal code for the primary parcel address of the record.
- PrimaryHearingBodyName; string; The name of the primary hearing body of the record.
- RecordType; string; The type of the planning and zoning application.
- RecordTypeId; string; The unique identifier of the type of the planning and zoning application.
- ScheduleDatetime; string; The date and time of the hearing schedule.
- ScheduleOrder; integer; The order of the hearings scheduled for a day.
- ScheduleStatus; string; The status of the hearing schedule.
- SequenceAction; string; The hearing sequence action of the record.
- SequenceActionDatetime; string; The date and time of the hearing sequence of the record.
- StaffDecisionName; string; The staff decision name.
- State; string; The state for the primary parcel address of the record.
- Status; string; The hearing schedule status.
- Subclassification; string; The subclassification of the planning and zoning application.
-
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 : publicSectorScheduledHearings
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 : publicSectorScheduledHearings-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
The first line for the primary parcel address of the record. -
Address2: string
Read Only:
true
The second line for the primary parcel address of the record. -
Address3: string
Read Only:
true
The third line for the primary parcel address of the record. -
Address4: string
Read Only:
true
The fourth line for the primary parcel address of the record. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
Default Value:1
The unique identifier of the agency. -
CancelAccess: array
Cancel Accesses
Title:
Cancel Accesses
The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing. -
City: string
Read Only:
true
The city for the primary parcel address of the record. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The classification of the of the planning and zoning application. -
Country: string
Read Only:
true
The country for the primary parcel address of the record. -
Description: string
Read Only:
true
Maximum Length:1000
The description of the planning and zoning application. -
EventDecision: string
Title:
Decision
Read Only:true
Maximum Length:15
The hearing event decision code. -
EventDecisionDatetime: string
(date-time)
Read Only:
true
The date and time of the hearing event decision. -
EventStatus: string
Title:
Decision Status
Read Only:true
Maximum Length:15
Default Value:ORA_NOTSTRTD
The hearing event status. -
HearingBodyCode: string
Title:
Hearing Body Code
Read Only:true
Maximum Length:60
The unique identifier of the hearing body. -
HearingBodyName: string
Title:
Hearing Body
Read Only:true
Maximum Length:255
The hearing body name. -
HearingDecisionCode: string
Title:
Decision
Read Only:true
Maximum Length:15
The hearing decision code. -
HearingDecisionName: string
Title:
Hearing Decision
Read Only:true
Maximum Length:255
The hearing decision name. -
HearingEventKey: integer
(int64)
Title:
Hearing Event Key
Read Only:true
The unique identifier of the hearing event record. -
HearingHierarchyCode: string
Title:
Hierarchy Code
Read Only:true
Maximum Length:60
The hearing hierarchy code of the record. -
HearingKey: integer
(int64)
Read Only:
true
The unique identifier of the hearing record. -
HearingSequenceKey: integer
(int64)
Read Only:
true
The unique identifier of the hearing sequence record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier of the planning and zoning application. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the planning and zoning application. -
ManageAccess: array
Manage Accesses
Title:
Manage Accesses
The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing. -
ParentEventKey: integer
(int64)
Read Only:
true
The unique identifier of the parent hearing event. -
ParentSequenceKey: integer
(int64)
Read Only:
true
The unique identifier of the parent hearing sequence. -
PermitAssignedId: integer
Title:
Permit Assignee ID
Read Only:true
The unique identifier of the planner assigned to the permit. -
PersonFirstName: string
Title:
Applicant First Name
Read Only:true
Maximum Length:150
The first name of the applicant. -
PersonLastName: string
Title:
Applicant Last Name
Read Only:true
Maximum Length:150
The last name of the applicant. -
PlannerName: string
Title:
Assigned Planner Name
Read Only:true
Maximum Length:255
The name of the planner assigned to the planning and zoning application. -
PostalCode: string
Read Only:
true
The postal code for the primary parcel address of the record. -
PrimaryHearingBodyName: string
Read Only:
true
Maximum Length:255
The name of the primary hearing body of the record. -
RecordType: string
Read Only:
true
Maximum Length:100
The type of the planning and zoning application. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier of the type of the planning and zoning application. -
ScheduleDatetime: string
(date-time)
Title:
Decision Date
Read Only:true
The date and time of the hearing schedule. -
ScheduleOrder: integer
(int32)
Read Only:
true
Default Value:0
The order of the hearings scheduled for a day. -
ScheduleStatus: string
Title:
Schedule Status
Read Only:true
Maximum Length:15
Default Value:ORA_UNSCHLD
The status of the hearing schedule. -
SequenceAction: string
Title:
Hearing Outcome
Read Only:true
Maximum Length:15
The hearing sequence action of the record. -
SequenceActionDatetime: string
(date-time)
Read Only:
true
The date and time of the hearing sequence of the record. -
StaffDecisionName: string
Title:
Staff Decision
Read Only:true
Maximum Length:255
The staff decision name. -
State: string
Read Only:
true
The state for the primary parcel address of the record. -
Status: string
Title:
Hearing Status
Read Only:true
Maximum Length:15
The hearing schedule status. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:10
The subclassification of the planning and zoning application.
Nested Schema : Cancel Accesses
Type:
array
Title:
Cancel Accesses
The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Manage Accesses
Type:
array
Title:
Manage Accesses
The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing.
Show Source
Nested Schema : publicSectorScheduledHearings-CancelAccess-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the planning and zoning application.
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 : publicSectorScheduledHearings-ManageAccess-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the planning and zoning application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source