Jump to

• Request
• Response

Get a hearing appeal

get

/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}

Request

Path Parameters

• HearingAppealKey(required): integer(int64)
  The unique identifier of the hearing appeal record.

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 Top

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.

Body ()

Root Schema : publicSectorHearingAppeals-item-response

Type: object

Show Source

• 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.
• ApplicantFlag: string
  Maximum Length: 1

  Default Value: N

  The flag to indicate whether the appellant is the applicant.
• 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.
• HearingSequenceKey: integer (int64)
  The 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.
• 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 submited.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the hearing was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDatetime":{
            "type":"string",
            "description":"The date and time when the hearing was submited.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HearingSequenceKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing sequence record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the appellant address.",
            "nullable":false,
            "x-queryable":true
        },
        "HearingAppealFees":{
            "title":"Hearing Appeal Fees",
            "type":"array",
            "description":"The hearing appeal fees resource is used to view hearing appeal fees.",
            "items":{
                "$ref":"#/components/schemas/publicSectorHearingAppeals-HearingAppealFees-item-response"
            }
        },
        "ApplicantFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The flag to indicate whether the appellant is the applicant.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the hearing appeal.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressThirdLine":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "AppellantPartyId":{
            "type":"integer",
            "description":"The unique identifier of the appellant party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the appellant.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressSecondLine":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the hearing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the hearing appeal.",
            "nullable":false,
            "default":"ORA_PEND",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the hearing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":100,
            "type":"string",
            "description":"The first name of the appellant.",
            "nullable":false,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":200,
            "type":"string",
            "description":"The email address of the appellant.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutId":{
            "type":"integer",
            "description":"The unique identifier of the payment checkout record.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Plus Code",
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressFourthLine":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "HearingAppealKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing appeal record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the appellant address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressFirstLine":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the appellant address.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country of the appellant address.",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":100,
            "type":"string",
            "description":"The last name of the appellant.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the hearing was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorHearingAppeals-HearingAppealFees-item-response

{
    "title":"Hearing Appeal Fees",
    "type":"array",
    "description":"The hearing appeal fees resource is used to view hearing appeal fees.",
    "items":{
        "$ref":"#/components/schemas/publicSectorHearingAppeals-HearingAppealFees-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorHearingAppeals-HearingAppealFees-item-response

Type: object

Show Source

• 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

  The 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: 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the hearing appeal fee was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingAppealFeeKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing appeal fee record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The payment date of the hearing appeal fee.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentDescription":{
            "title":"Department",
            "maxLength":255,
            "type":"string",
            "description":"The description of the department associated with the hearing appeal fee item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "type":"string",
            "description":"The payment method code of the hearing appeal fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The currency code of the hearing appeal fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference",
            "type":"string",
            "description":"The payment reference identifier of the hearing appeal fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The assessed date of the hearing appeal fee.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique identifier of the payment history record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingAppealKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing appeal record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the permit fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the permit fee record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeItemDescription":{
            "title":"Fee Description",
            "type":"string",
            "description":"The description of the hearing appeal fee item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the hearing appeal fee was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The hearing appeal fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

HearingAppealFees

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorHearingAppeals/{HearingAppealKey}/child/HearingAppealFees

Parameters:

• HearingAppealKey: $request.path.HearingAppealKey

The hearing appeal fees resource is used to view hearing appeal fees.

Back to Top