Get a hearing notification
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications/{publicSectorHearingNotificationsUniqID}
Request
Path Parameters
-
publicSectorHearingNotificationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- HearingKey, HearingSequenceKey and HearingEventKey ---for the Hearing Notifications resource and used to uniquely identify an instance of Hearing Notifications. The client should not generate the hash key value. Instead, the client should query on the Hearing Notifications collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Notifications.
For example: publicSectorHearingNotifications?q=HearingKey=<value1>;HearingSequenceKey=<value2>;HearingEventKey=<value3>
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 : publicSectorHearingNotifications-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first line of address of the applicant. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second line of address of the applicant. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
The third line of address of the applicant. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth line of address of the applicant. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency. -
ApplicationLink(optional):
string
Title:
Application Link
The link to the planning and zoning application. -
AssigneeEmailId(optional):
string
Title:
Planner Email Address
The email address of the assigned planner. -
AssigneeFirstName(optional):
string
Title:
Planner First Name
The first name of the assigned planner. -
AssigneeLastName(optional):
string
Title:
Planner Last Name
The last name of the assigned planner. -
AssigneeUserId(optional):
string
Title:
Planner ID
The unique identifier of the assigned planner. -
CityName(optional):
string
Title:
City
Maximum Length:60
The city of the applicant address. -
CountryCode(optional):
string
Title:
Country
Maximum Length:3
The country code of the applicant address. -
CountyCodeIncits(optional):
string
Title:
County
Maximum Length:60
The county code of the applicant address. -
EmailAddress1(optional):
string
Title:
Applicant Email Address 1
Maximum Length:320
The email address of the applicant. -
EmailAddress2(optional):
string
Title:
Applicant Email Address 2
Maximum Length:320
The alternate email address of the applicant. -
HearingBodyCode(optional):
string
Title:
Hearing Body Code
Maximum Length:60
The unique identifier of the hearing body. -
HearingBodyDescription(optional):
string
Title:
Additional Information
Maximum Length:800
The description of the hearing body of the record. -
HearingBodyName(optional):
string
Title:
Hearing Body
Maximum Length:200
The name of the hearing body of the record. -
HearingDecisionCode(optional):
string
Title:
Hearing Decision
Maximum Length:15
The hearing decision code. -
HearingDecisionDescription(optional):
string
Title:
Hearing Decision Description
Maximum Length:800
The description of the hearing decision of the record. -
HearingDecisionName(optional):
string
Title:
Decision
Maximum Length:60
The name of the hearing decision of the record. -
HearingEventKey(optional):
integer(int64)
The unique identifier of the hearing event record.
-
HearingKey(optional):
integer(int64)
The unique identifier of the hearing record.
-
HearingSequenceKey(optional):
integer(int64)
The unique identifier of the hearing sequence record.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Application ID
Maximum Length:50
The unique identifier of the planning and zoning application. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the planning and zoning application.
-
PersonFirstName(optional):
string
Title:
Applicant First Name
Maximum Length:150
The first name of the applicant. -
PersonLastName(optional):
string
Title:
Applicant Last Name
Maximum Length:150
The last name of the applicant. -
PreviousScheduleDatetime(optional):
string
Title:
Original Scheduled Date and Time
The original date and time of the hearing schedule. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province of the applicant address. -
ScheduleDatetime(optional):
string(date-time)
Title:
Hearing Date
The date and time of the hearing schedule. -
ScheduleStatus(optional):
string
Title:
Schedule Status
Maximum Length:80
The status of the hearing schedule. -
SequenceAction(optional):
string
Title:
Hearing Outcome
Maximum Length:15
The hearing sequence action of the record. -
StateCodeISO(optional):
string
Title:
State
Maximum Length:60
The state code of the applicant address. -
ZipCode(optional):
string
Title:
Postal Code
Maximum Length:60
The zip code of the applicant address.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.