Get all hearing notifications
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications
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 notification that matches the specified hearing key, hearing sequence, and hearing event.
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.
- LnpRecordKey; integer; The unique identifier of the planning and zoning application.
- PrimaryKey: Finds the hearing notification that matches the specified hearing key, hearing sequence, and hearing event.
-
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 of address of the applicant.
- Address2; string; The second line of address of the applicant.
- Address3; string; The third line of address of the applicant.
- Address4; string; The fourth line of address of the applicant.
- AgencyId; integer; The unique identifier of the agency.
- AssigneeEmailId; string; The email address of the assigned planner.
- AssigneeFirstName; string; The first name of the assigned planner.
- AssigneeLastName; string; The last name of the assigned planner.
- AssigneeUserId; string; The unique identifier of the assigned planner.
- BRFAttachmentId; string; The unique identifier for a hearing business rule attachment.
- CityName; string; The city of the applicant address.
- Classification; string; The classification of the record. The classification can be permit, business license, professional license, or planning and zoning.
- CountryCode; string; The country code of the applicant address.
- CountyCodeIncits; string; The county code of the applicant address.
- EmailAddress1; string; The email address of the applicant.
- EmailAddress2; string; The alternate email address of the applicant.
- HearingBodyCode; string; The unique identifier of the hearing body.
- HearingBodyDescription; string; The description of the hearing body of the record.
- HearingBodyName; string; The name of the hearing body of the record.
- HearingDecisionCode; string; The hearing decision code.
- HearingDecisionDescription; string; The description of the hearing decision of the record.
- HearingDecisionName; string; The name of the hearing decision of the record.
- HearingEventKey; integer; The unique identifier of the hearing event 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.
- PersonFirstName; string; The first name of the applicant.
- PersonLastName; string; The last name of the applicant.
- PreviousScheduleDatetime; string; The original date and time of the hearing schedule.
- Province; string; The province of the applicant address.
- ScheduleDatetime; string; The date and time of the hearing schedule.
- ScheduleStatus; string; The status of the hearing schedule.
- SequenceAction; string; The hearing sequence action of the record.
- StateCodeISO; string; The state code of the applicant address.
- Subclassification; string; Indicates that the record type is used for the pre-application process.
- WfProcessId; number; The unique identifier for a workflow process ID.
- ZipCode; string; The zip code of the applicant address.
-
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 : publicSectorHearingNotifications
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 : publicSectorHearingNotifications-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
The first line of address of the applicant. -
Address2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
The second line of address of the applicant. -
Address3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The third line of address of the applicant. -
Address4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The fourth line of address of the applicant. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
Default Value:1
The unique identifier of the agency. -
ApplicationLink: string
Title:
Application Link
Read Only:true
The link to the planning and zoning application. -
AssigneeEmailId: string
Title:
Planner Email Address
Read Only:true
The email address of the assigned planner. -
AssigneeFirstName: string
Title:
Planner First Name
Read Only:true
The first name of the assigned planner. -
AssigneeLastName: string
Title:
Planner Last Name
Read Only:true
The last name of the assigned planner. -
AssigneeUserId: string
Title:
Planner ID
Read Only:true
The unique identifier of the assigned planner. -
BRFAttachmentId: string
Title:
Rules Framework Attachments
Read Only:true
Maximum Length:255
The unique identifier for a hearing business rule attachment. -
CityName: string
Title:
City
Read Only:true
Maximum Length:60
The city of the applicant address. -
Classification: string
Read Only:
true
Maximum Length:3
The classification of the record. The classification can be permit, business license, professional license, or planning and zoning. -
CountryCode: string
Title:
Country
Read Only:true
Maximum Length:3
The country code of the applicant address. -
CountyCodeIncits: string
Title:
County
Read Only:true
Maximum Length:60
The county code of the applicant address. -
EmailAddress1: string
Title:
Applicant Email Address 1
Read Only:true
Maximum Length:320
The email address of the applicant. -
EmailAddress2: string
Title:
Applicant Email Address 2
Read Only:true
Maximum Length:320
The alternate email address of the applicant. -
HearingBodyCode: string
Title:
Hearing Body Code
Read Only:true
Maximum Length:60
The unique identifier of the hearing body. -
HearingBodyDescription: string
Title:
Additional Information
Read Only:true
Maximum Length:800
The description of the hearing body of the record. -
HearingBodyName: string
Title:
Decision Making Body
Read Only:true
Maximum Length:200
The name of the hearing body of the record. -
HearingDecisionCode: string
Title:
Decision Code
Read Only:true
Maximum Length:15
The hearing decision code. -
HearingDecisionDescription: string
Title:
Hearing Decision Description
Read Only:true
Maximum Length:800
The description of the hearing decision of the record. -
HearingDecisionName: string
Title:
Decision
Read Only:true
Maximum Length:60
The name of the hearing decision of the record. -
HearingEventKey: integer
(int64)
Title:
Hearing Event Key
Read Only:true
The unique identifier of the hearing event 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
Title:
Application ID
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. -
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. -
PreviousScheduleDatetime: string
Title:
Original Scheduled Date and Time
Read Only:true
The original date and time of the hearing schedule. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
The province of the applicant address. -
ScheduleDatetime: string
(date-time)
Title:
Decision Date
Read Only:true
The date and time of the hearing schedule. -
ScheduleStatus: string
Title:
Schedule Status
Read Only:true
Maximum Length:80
The status of the hearing schedule. -
SequenceAction: string
Title:
Hearing Outcome
Read Only:true
Maximum Length:15
The hearing sequence action of the record. -
StateCodeISO: string
Title:
State
Read Only:true
Maximum Length:60
The state code of the applicant address. -
Subclassification: string
Read Only:
true
Maximum Length:10
Indicates that the record type is used for the pre-application process. -
WfProcessId: number
Read Only:
true
The unique identifier for a workflow process ID. -
ZipCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The zip code of the applicant address.
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.