Get all hearing appeals
get
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals
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 appeal that matches the specified search criteria.
Finder Variables:- HearingAppealKey; integer; The unique identifier of the hearing appeal.
- PrimaryKey: Finds the hearing appeal 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:- AddressFirstLine; string; The first line of the appellant address.
- AddressFourthLine; string; The fourth line of the appellant address.
- AddressSecondLine; string; The second line of the appellant address.
- AddressThirdLine; string; The third line of the appellant address.
- AppellantPartyId; integer; The unique identifier of the appellant party.
- AppellantPartyPuid; string; The public unique identifier of the appellant party.
- ApplicantFlag; string; The flag to indicate whether the appellant is the applicant.
- City; string; The city of the appellant address.
- Country; string; The country of the appellant address.
- County; string; The county of the appellant address.
- CreatedBy; string; The name of the user who created the hearing.
- CreationDate; string; The date and time when the hearing was created.
- EmailAddress; string; The email address of the appellant.
- FirstName; string; The first name of the appellant.
- HearingAppealKey; integer; The unique identifier of the hearing appeal record.
- HearingAppealPuid; string; The public unique identifier of the hearing appeal record.
- HearingSequenceKey; integer; The unique identifier of the hearing sequence record.
- HearingSequencePuid; string; The public unique identifier of the hearing sequence record.
- LastName; string; The last name of the appellant.
- LastUpdateDate; string; The date and time when the hearing was last updated.
- LastUpdatedBy; string; The name of the user who last updated the hearing.
- Phone; string; The phone number of the appellant.
- PostalCode; string; The postal code of the appellant address.
- PostalPlus4Code; string; The postal plus code of the appellant address.
- Province; string; The province of the appellant address.
- Reason; string; The reason for the hearing appeal.
- State; string; The state of the appellant address.
- Status; string; The status of the hearing appeal.
- SubmitDatetime; string; The date and time when the hearing was submitted.
-
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:
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.
Root Schema : publicSectorHearingAppeals
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 : publicSectorHearingAppeals-item-response
Type:
Show Source
object
-
AddressFirstLine: string
Title:
Address Line 1
Maximum Length:240
The first line of the appellant address. -
AddressFourthLine: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the appellant address. -
AddressSecondLine: string
Title:
Address Line 2
Maximum Length:240
The second line of the appellant address. -
AddressThirdLine: string
Title:
Address Line 3
Maximum Length:240
The third line of the appellant address. -
AppellantPartyId: integer
(int64)
The unique identifier of the appellant party.
-
AppellantPartyPuid: string
Maximum Length:
255
The public unique identifier of the appellant party. -
ApplicantFlag: string
Maximum Length:
1
Default Value:N
The flag to indicate whether the appellant is the applicant. -
CheckoutFlag: string
Maximum Length:
80
Indicates whether the case fees has to be paid or recalculated. -
CheckoutId: integer
The unique identifier of the payment checkout record.
-
City: string
Title:
City
Maximum Length:60
The city of the appellant address. -
Country: string
Title:
Country
Maximum Length:3
The country of the appellant address. -
County: string
Title:
County
Maximum Length:60
The county of the appellant address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the hearing. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the hearing was created. -
EmailAddress: string
Title:
Email
Maximum Length:200
The email address of the appellant. -
FirstName: string
Title:
First Name
Maximum Length:100
The first name of the appellant. -
HearingAppealFees: array
Hearing Appeal Fees
Title:
Hearing Appeal Fees
The hearing appeal fees resource is used to view hearing appeal fees. -
HearingAppealKey: integer
(int64)
The unique identifier of the hearing appeal record.
-
HearingAppealPuid: string
Maximum Length:
480
Default Value:0
The public unique identifier of the hearing appeal record. -
HearingSequenceKey: integer
(int64)
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. -
LastName: string
Title:
Last Name
Maximum Length:100
The last name of the appellant. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the hearing was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the hearing. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Phone: string
Title:
Phone
Maximum Length:100
The phone number of the appellant. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the appellant address. -
PostalPlus4Code: string
Title:
Postal Plus Code
Maximum Length:10
The postal plus code of the appellant address. -
Province: string
Title:
Province
Maximum Length:60
The province of the appellant address. -
Reason: string
Title:
Reason
Maximum Length:1000
The reason for the hearing appeal. -
SearchId: string
Maximum Length:
80
The search identifier for the case fee search request. -
State: string
Title:
State
Maximum Length:60
The state of the appellant address. -
Status: string
Maximum Length:
15
Default Value:ORA_PEND
The status of the hearing appeal. -
SubmitDatetime: string
(date-time)
The date and time when the hearing was submitted.
Nested Schema : Hearing Appeal Fees
Type:
array
Title:
Hearing Appeal Fees
The hearing appeal fees resource is used to view hearing appeal fees.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorHearingAppeals-HearingAppealFees-item-response
Type:
Show Source
object
-
AssessedDate: string
(date)
Title:
Assessed Date
Read Only:true
The assessed date of the hearing appeal fee. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the hearing appeal fee was created. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
The currency code of the hearing appeal fee amount. -
DepartmentDescription: string
Title:
Department
Read Only:true
Maximum Length:255
The description of the department associated with the hearing appeal fee item. -
FeeAmount: number
Title:
Amount
Read Only:true
The hearing appeal fee amount. -
FeeItemDescription: string
Title:
Fee Description
Read Only:true
The description of the hearing appeal fee item. -
FeeRecordKey: integer
(int64)
The unique identifier of the permit fee record.
-
FeeRecordPuid: string
Maximum Length:
480
Default Value:0
The unique identifier of the permit fee record. -
HearingAppealFeeKey: integer
(int64)
The unique identifier of the hearing appeal fee record.
-
HearingAppealFeePuid: string
Maximum Length:
480
The public unique identifier of the hearing appeal fee record. -
HearingAppealKey: integer
(int64)
The unique identifier of the hearing appeal record.
-
HearingAppealPuid: string
Maximum Length:
480
Default Value:0
The public unique identifier of the hearing appeal record. -
HearingSequenceKey: integer
Read Only:
true
The unique identifier of the hearing sequence record. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the hearing appeal fee was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentDate: string
(date-time)
Title:
Payment Date
Read Only:true
The payment date of the hearing appeal fee. -
PaymentHistoryKey: integer
Read Only:
true
The unique identifier of the payment history record. -
PaymentMethodCode: string
Title:
Payment Method
Read Only:true
The payment method code of the hearing appeal fee. -
PaymentReferenceId: string
Title:
Payment Reference
Read Only:true
The payment reference identifier of the hearing appeal fee.
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.