Get a hearing
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearings/{publicSectorHearingsUniqID}
Request
Path Parameters
-
publicSectorHearingsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Hearings resource and used to uniquely identify an instance of Hearings. The client should not generate the hash key value. Instead, the client should query on the Hearings collection resource in order to navigate to a specific instance of Hearings to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorHearings-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
Default Value:1
The unique identifier of the agency. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the hearing was created. -
DecisionComments: string
Title:
Comments
Maximum Length:1000
The comments on the decision. -
EventDecision: string
Title:
Decision
Maximum Length:15
The decision of the hearing event. -
EventDecisionDatetime: string
(date-time)
The date and time of the hearing event decision.
-
EventStatus: string
Title:
Decision Status
Maximum Length:15
Default Value:ORA_NOTSTRTD
The status of the hearing event. -
HearingAppealKey: integer
(int64)
Read Only:
true
The unique identifier of the hearing appeal record. -
HearingBodyCode: string
Title:
Hearing Body Code
Read Only:true
Maximum Length:60
The code of the hearing body record. -
HearingBodyName: string
Title:
Decision Making Body
Read Only:true
Maximum Length:200
The name of the hearing body record. -
HearingDecisionCode: string
Title:
Decision
Maximum Length:15
The unique identifier of the hearing decision. -
HearingDecisionName: string
Title:
Decision
Read Only:true
Maximum Length:60
The name of the hearing decision. -
HearingEventKey: integer
(int64)
Title:
Hearing Event Key
Read Only:true
The unique identifier of the hearing event record. -
HearingEventPuid: string
Maximum Length:
480
Default Value:0
The public unique identifier of the hearing event record. -
HearingHierarchyCode: string
Title:
Hierarchy Code
Maximum Length:60
The code of the hearing hierarchy record. -
HearingKey: integer
(int64)
Read Only:
true
The unique identifier of the hearing record. -
HearingPuid: string
Maximum Length:
480
The public unique identifier of the hearing record. -
HearingSequenceKey: integer
(int64)
Read Only:
true
The unique identifier of the hearing sequence record. -
HearingSequencePuid: string
Maximum Length:
480
Default Value:0
The public unique identifier of the hearing sequence record. -
IsAppealAllowedFlag: string
Read Only:
true
The flag to indicate whether appeal is allowed. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the hearing was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier of the planning and zoning application.
-
LnpRecordPuid: string
Maximum Length:
480
The public unique identifier of the planning and zoning application. -
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. -
ScheduleDatetime: string
(date-time)
Title:
Decision Date
The date and time of the scheduled hearing. -
ScheduleOrder: integer
(int32)
Default Value:
0
The order of the hearings scheduled for a day. -
ScheduleStatus: string
Title:
Schedule Status
Maximum Length:15
Default Value:ORA_UNSCHLD
The status of the hearing schedule. For example Tentative, Final. -
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 record. -
StaffDecisionCode: string
Maximum Length:
15
The unique identifier of the staff decision. -
StaffDecisionComments: string
Title:
Comments
Maximum Length:1000
The comments of the staff decision. -
StaffDecisionDatetime: string
(date-time)
Title:
Staff Recommendation Date
The date and time when the staff decision was updated. -
StaffDecisionName: string
Read Only:
true
Maximum Length:255
The name of the staff decision.
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.