Get a hearing appeal
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}
Request
Path Parameters
-
HearingAppealKey: integer
The unique identifier of the hearing appeal record.
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 : publicSectorHearingAppeals-item
Type:
Show Source
object
-
AddressFirstLine(optional):
string
Title:
Address Line 1
Maximum Length:240
The first line of the appellant address. -
AddressFourthLine(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth line of the appellant address. -
AddressSecondLine(optional):
string
Title:
Address Line 2
Maximum Length:240
The second line of the appellant address. -
AddressThirdLine(optional):
string
Title:
Address Line 3
Maximum Length:240
The third line of the appellant address. -
AppellantPartyId(optional):
integer(int64)
The unique identifier of the appellant party.
-
City(optional):
string
Title:
City
Maximum Length:60
The city of the appellant address. -
Country(optional):
string
Title:
Country
Maximum Length:3
The country of the appellant address. -
County(optional):
string
Title:
County
Maximum Length:60
The county of the appellant address. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the hearing. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the hearing was created. -
EmailAddress(optional):
string
Title:
Email
Maximum Length:200
The email address of the appellant. -
FirstName(optional):
string
Title:
First Name
Maximum Length:100
The first name of the appellant. -
HearingAppealKey(optional):
integer(int64)
The unique identifier of the hearing appeal record.
-
HearingSequenceKey(optional):
integer(int64)
The unique identifier of the hearing sequence record.
-
LastName(optional):
string
Title:
Last Name
Maximum Length:100
The last name of the appellant. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the hearing was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the hearing. -
links(optional):
array Items
Title:
Items
Link Relations -
Phone(optional):
string
Title:
Phone
Maximum Length:100
The phone number of the appellant. -
PostalCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code of the appellant address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus Code
Maximum Length:10
The postal plus code of the appellant address. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province of the appellant address. -
Reason(optional):
string
Title:
Reason
Maximum Length:1000
The reason for the hearing appeal. -
State(optional):
string
Title:
State
Maximum Length:60
The state of the appellant address. -
Status(optional):
string
Maximum Length:
15
The status of the hearing appeal.
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.