Create a set of hearing appeals
post
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object-
AddressFirstLine(required): string
Title:
Address Line 1Maximum Length:240The first line of the appellant address. -
AddressFourthLine: string
Title:
Address Line 4Maximum Length:240The fourth line of the appellant address. -
AddressSecondLine: string
Title:
Address Line 2Maximum Length:240The second line of the appellant address. -
AddressThirdLine: string
Title:
Address Line 3Maximum Length:240The third line of the appellant address. -
AppellantPartyId: integer
(int64)
The unique identifier of the appellant party.
-
ApplicantFlag: string
Maximum Length:
1Default Value:NThe flag to indicate whether the appellant is the applicant. -
CheckoutId: integer
The unique identifier of the payment checkout record.
-
City: string
Title:
CityMaximum Length:60The city of the appellant address. -
Country(required): string
Title:
CountryMaximum Length:3The country of the appellant address. -
County: string
Title:
CountyMaximum Length:60The county of the appellant address. -
EmailAddress: string
Title:
EmailMaximum Length:200The email address of the appellant. -
FirstName(required): string
Title:
First NameMaximum Length:100The first name of the appellant. -
HearingAppealFees: array
Hearing Appeal Fees
Title:
Hearing Appeal FeesThe hearing appeal fees resource is used to view hearing appeal fees. -
HearingAppealKey: integer
(int64)
The unique identifier of the hearing appeal record.
-
HearingSequenceKey(required): integer
(int64)
The unique identifier of the hearing sequence record.
-
LastName(required): string
Title:
Last NameMaximum Length:100The last name of the appellant. -
Phone: string
Title:
PhoneMaximum Length:100The phone number of the appellant. -
PostalCode(required): string
Title:
Postal CodeMaximum Length:60The postal code of the appellant address. -
PostalPlus4Code: string
Title:
Postal Plus CodeMaximum Length:10The postal plus code of the appellant address. -
Province: string
Title:
ProvinceMaximum Length:60The province of the appellant address. -
Reason(required): string
Title:
ReasonMaximum Length:1000The reason for the hearing appeal. -
State: string
Title:
StateMaximum Length:60The state of the appellant address. -
Status: string
Maximum Length:
15Default Value:ORA_PENDThe status of the hearing appeal. -
SubmitDatetime: string
(date-time)
The date and time when the hearing was submited.
Nested Schema : Hearing Appeal Fees
Type:
arrayTitle:
Hearing Appeal FeesThe hearing appeal fees resource is used to view hearing appeal fees.
Show Source
Nested Schema : publicSectorHearingAppeals-HearingAppealFees-item-post-request
Type:
Show Source
object-
FeeRecordKey: integer
(int64)
The unique identifier of the permit fee record.
-
FeeRecordPuid: string
Maximum Length:
480The unique identifier of the permit fee record. -
HearingAppealFeeKey: integer
(int64)
The unique identifier of the hearing appeal fee record.
-
HearingAppealKey: integer
(int64)
The unique identifier of the hearing appeal record.
Response
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 : publicSectorHearingAppeals-item-response
Type:
Show Source
object-
AddressFirstLine: string
Title:
Address Line 1Maximum Length:240The first line of the appellant address. -
AddressFourthLine: string
Title:
Address Line 4Maximum Length:240The fourth line of the appellant address. -
AddressSecondLine: string
Title:
Address Line 2Maximum Length:240The second line of the appellant address. -
AddressThirdLine: string
Title:
Address Line 3Maximum Length:240The third line of the appellant address. -
AppellantPartyId: integer
(int64)
The unique identifier of the appellant party.
-
ApplicantFlag: string
Maximum Length:
1Default Value:NThe flag to indicate whether the appellant is the applicant. -
CheckoutId: integer
The unique identifier of the payment checkout record.
-
City: string
Title:
CityMaximum Length:60The city of the appellant address. -
Country: string
Title:
CountryMaximum Length:3The country of the appellant address. -
County: string
Title:
CountyMaximum Length:60The county of the appellant address. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the hearing. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the hearing was created. -
EmailAddress: string
Title:
EmailMaximum Length:200The email address of the appellant. -
FirstName: string
Title:
First NameMaximum Length:100The first name of the appellant. -
HearingAppealFees: array
Hearing Appeal Fees
Title:
Hearing Appeal FeesThe hearing appeal fees resource is used to view hearing appeal fees. -
HearingAppealKey: integer
(int64)
The unique identifier of the hearing appeal record.
-
HearingSequenceKey: integer
(int64)
The unique identifier of the hearing sequence record.
-
LastName: string
Title:
Last NameMaximum Length:100The last name of the appellant. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the hearing was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the hearing. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Phone: string
Title:
PhoneMaximum Length:100The phone number of the appellant. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the appellant address. -
PostalPlus4Code: string
Title:
Postal Plus CodeMaximum Length:10The postal plus code of the appellant address. -
Province: string
Title:
ProvinceMaximum Length:60The province of the appellant address. -
Reason: string
Title:
ReasonMaximum Length:1000The reason for the hearing appeal. -
State: string
Title:
StateMaximum Length:60The state of the appellant address. -
Status: string
Maximum Length:
15Default Value:ORA_PENDThe status of the hearing appeal. -
SubmitDatetime: string
(date-time)
The date and time when the hearing was submited.
Nested Schema : Hearing Appeal Fees
Type:
arrayTitle:
Hearing Appeal FeesThe hearing appeal fees resource is used to view hearing appeal fees.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorHearingAppeals-HearingAppealFees-item-response
Type:
Show Source
object-
AssessedDate: string
(date)
Title:
Assessed DateRead Only:trueThe assessed date of the hearing appeal fee. -
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the hearing appeal fee was created. -
CurrencyCode: string
Title:
Currency CodeRead Only:trueThe currency code of the hearing appeal fee amount. -
DepartmentDescription: string
Title:
DepartmentRead Only:trueMaximum Length:255The description of the department associated with the hearing appeal fee item. -
FeeAmount: number
Title:
AmountRead Only:trueThe hearing appeal fee amount. -
FeeItemDescription: string
Title:
Fee DescriptionRead Only:trueThe description of the hearing appeal fee item. -
FeeRecordKey: integer
(int64)
The unique identifier of the permit fee record.
-
FeeRecordPuid: string
Maximum Length:
480The unique identifier of the permit fee record. -
HearingAppealFeeKey: integer
(int64)
The unique identifier of the hearing appeal fee record.
-
HearingAppealKey: integer
(int64)
The unique identifier of the hearing appeal record.
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the hearing appeal fee was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PaymentDate: string
(date-time)
Title:
Payment DateRead Only:trueThe payment date of the hearing appeal fee. -
PaymentHistoryKey: integer
Read Only:
trueThe unique identifier of the payment history record. -
PaymentMethodCode: string
Title:
Payment MethodRead Only:trueThe payment method code of the hearing appeal fee. -
PaymentReferenceId: string
Title:
Payment ReferenceRead Only:trueThe payment reference identifier of the hearing appeal fee.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- HearingAppealFees
-
Parameters:
- HearingAppealKey:
$request.path.HearingAppealKey
The hearing appeal fees resource is used to view hearing appeal fees. - HearingAppealKey: