Jump to

• Request
• Response

Get a hearing notification

get

/fscmRestApi/resources/11.13.18.05/publicSectorHearingNotifications/{publicSectorHearingNotificationsUniqID}

Request

Path Parameters

• publicSectorHearingNotificationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey, 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=LnpRecordKey=<value1>;HearingKey=<value2>;HearingSequenceKey=<value3>;HearingEventKey=<value4>

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

Body ()

Root Schema : publicSectorHearingNotifications-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of address of the applicant.
• Address2: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of address of the applicant.
• Address3: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  The third line of address of the applicant.
• Address4: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  The fourth line of address of the applicant.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  Default Value: 1

  The unique identifier of the agency.
• ApplicationLink: string
  Title: Application Link

  Read Only: true

  The link to the planning and zoning application.
• AssigneeEmailId: string
  Title: Planner Email Address

  Read Only: true

  The email address of the assigned planner.
• AssigneeFirstName: string
  Title: Planner First Name

  Read Only: true

  The first name of the assigned planner.
• AssigneeLastName: string
  Title: Planner Last Name

  Read Only: true

  The last name of the assigned planner.
• AssigneeUserId: string
  Title: Planner ID

  Read Only: true

  The unique identifier of the assigned planner.
• BRFAttachmentId: string
  Title: Rules Framework Attachments

  Read Only: true

  Maximum Length: 255

  The unique identifier for a hearing business rule attachment.
• CityName: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the applicant address.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the record. The classification can be permit, business license, professional license, or planning and zoning.
• CountryCode: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country code of the applicant address.
• CountyCodeIncits: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county code of the applicant address.
• EmailAddress1: string
  Title: Applicant Email Address 1

  Read Only: true

  Maximum Length: 320

  The email address of the applicant.
• EmailAddress2: string
  Title: Applicant Email Address 2

  Read Only: true

  Maximum Length: 320

  The alternate email address of the applicant.
• HearingBodyCode: string
  Title: Hearing Body Code

  Read Only: true

  Maximum Length: 60

  The unique identifier of the hearing body.
• HearingBodyDescription: string
  Title: Additional Information

  Read Only: true

  Maximum Length: 800

  The description of the hearing body of the record.
• HearingBodyName: string
  Title: Decision Making Body

  Read Only: true

  Maximum Length: 200

  The name of the hearing body of the record.
• HearingDecisionCode: string
  Title: Decision Code

  Read Only: true

  Maximum Length: 15

  The hearing decision code.
• HearingDecisionDescription: string
  Title: Hearing Decision Description

  Read Only: true

  Maximum Length: 800

  The description of the hearing decision of the record.
• HearingDecisionName: string
  Title: Decision

  Read Only: true

  Maximum Length: 60

  The name of the hearing decision of the record.
• HearingEventKey: integer (int64)
  Title: Hearing Event Key

  Read Only: true

  The unique identifier of the hearing event record.
• HearingKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing record.
• HearingSequenceKey: integer (int64)
  Read Only: true

  The unique identifier of the hearing sequence record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Application ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the planning and zoning application.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the planning and zoning application.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The first name of the applicant.
• PersonLastName: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the applicant.
• PreviousScheduleDatetime: string
  Title: Original Scheduled Date and Time

  Read Only: true

  The original date and time of the hearing schedule.
• Province: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province of the applicant address.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  Read Only: true

  The date and time of the hearing schedule.
• ScheduleStatus: string
  Title: Schedule Status

  Read Only: true

  Maximum Length: 80

  The status of the hearing schedule.
• SequenceAction: string
  Title: Hearing Outcome

  Read Only: true

  Maximum Length: 15

  The hearing sequence action of the record.
• StateCodeISO: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state code of the applicant address.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  Indicates that the record type is used for the pre-application process.
• WfProcessId: number
  Read Only: true

  The unique identifier for a workflow process ID.
• ZipCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The zip code of the applicant address.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates that the record type is used for the pre-application process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HearingDecisionCode":{
            "title":"Decision Code",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing decision code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PreviousScheduleDatetime":{
            "title":"Original Scheduled Date and Time",
            "type":"string",
            "description":"The original date and time of the hearing schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingSequenceKey":{
            "type":"integer",
            "description":"The unique identifier of the hearing sequence record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleDatetime":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date and time of the hearing schedule.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Email Address 1",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "EmailAddress2":{
            "title":"Applicant Email Address 2",
            "maxLength":"320",
            "type":"string",
            "description":"The alternate email address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "HearingEventKey":{
            "title":"Hearing Event Key",
            "type":"integer",
            "description":"The unique identifier of the hearing event record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WfProcessId":{
            "type":"number",
            "description":"The unique identifier for a workflow process ID.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record. The classification can be permit, business license, professional license, or planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionName":{
            "title":"Decision",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the hearing decision of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssigneeLastName":{
            "title":"Planner Last Name",
            "type":"string",
            "description":"The last name of the assigned planner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country code of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceAction":{
            "title":"Hearing Outcome",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing sequence action of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionDescription":{
            "title":"Hearing Decision Description",
            "maxLength":"800",
            "type":"string",
            "description":"The description of the hearing decision of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the planning and zoning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeUserId":{
            "title":"Planner ID",
            "type":"string",
            "description":"The unique identifier of the assigned planner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssigneeFirstName":{
            "title":"Planner First Name",
            "type":"string",
            "description":"The first name of the assigned planner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCodeISO":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state code of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ZipCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The zip code of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeEmailId":{
            "title":"Planner Email Address",
            "type":"string",
            "description":"The email address of the assigned planner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CityName":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HearingBodyDescription":{
            "title":"Additional Information",
            "maxLength":"800",
            "type":"string",
            "description":"The description of the hearing body of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountyCodeIncits":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county code of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingBodyName":{
            "title":"Decision Making Body",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the hearing body of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BRFAttachmentId":{
            "title":"Rules Framework Attachments",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for a hearing business rule attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "AttachParams":"AttachmentType,LogId,RuleLogId,RecordIdentifier,RecordFirstKeyName,RecordFirstKeyValue,RecordSecondKeyName,RecordSecondKeyValue,RecordThirdKeyName,RecordThirdKeyValue,RecordFourthKeyName,RecordFourthKeyValue,ExecutionId",
                "Restname":"publicSectorBusinessRulesFrameworkAttachments",
                "ServiceType":"BRF",
                "Accessor":"EventMgmtAttachmentAccessor",
                "Attachments":"true"
            },
            "x-queryable":true
        },
        "ApplicationLink":{
            "title":"Application Link",
            "type":"string",
            "description":"The link to the planning and zoning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the hearing schedule.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top