Jump to

• Request
• Response

Get all scheduled hearings

get

/fscmRestApi/resources/11.13.18.05/publicSectorScheduledHearings

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 scheduled hearing that matches the specified search criteria.
    Finder Variables:
    • HearingEventKey; integer; The unique identifier of the hearing event.
    • HearingKey; integer; The unique identifier of the hearing.
    • HearingSequenceKey; integer; The unique identifier of the hearing sequence.
  • scheduledEventsFinder: Finds the scheduled hearing that matches the specified search criteria.
    Finder Variables:
    • hearingBodyCode; string; The hearing body code.
    • scheduleEndDateTime; string; The end date and time of the hearing schedule.
    • scheduleStartDateTime; string; The start date and time of the hearing schedule.
  • simpleSearchFinder: Finds the scheduled hearing that matches the specified search criteria.
    Finder Variables:
    • searchValue; string; The search value for using in the 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:
  

  • Address1; string; The first line for the primary parcel address of the record.
  • Address2; string; The second line for the primary parcel address of the record.
  • Address3; string; The third line for the primary parcel address of the record.
  • Address4; string; The fourth line for the primary parcel address of the record.
  • AgencyId; integer; The unique identifier of the agency.
  • City; string; The city for the primary parcel address of the record.
  • Classification; string; The classification of the of the planning and zoning application.
  • Country; string; The country for the primary parcel address of the record.
  • Description; string; The description of the planning and zoning application.
  • EventDecision; string; The hearing event decision code.
  • EventDecisionDatetime; string; The date and time of the hearing event decision.
  • EventStatus; string; The hearing event status.
  • HearingBodyCode; string; The unique identifier of the hearing body.
  • HearingBodyName; string; The hearing body name.
  • HearingDecisionCode; string; The hearing decision code.
  • HearingDecisionName; string; The hearing decision name.
  • HearingEventKey; integer; The unique identifier of the hearing event record.
  • HearingHierarchyCode; string; The hearing hierarchy code of the record.
  • HearingKey; integer; The unique identifier of the hearing record.
  • HearingSequenceKey; integer; The unique identifier of the hearing sequence record.
  • LnpRecordId; string; The unique identifier of the planning and zoning application.
  • LnpRecordKey; integer; The unique identifier of the planning and zoning application.
  • ParentEventKey; integer; The unique identifier of the parent hearing event.
  • ParentSequenceKey; integer; The unique identifier of the parent hearing sequence.
  • PermitAssignedId; integer; The unique identifier of the planner assigned to the permit.
  • PersonFirstName; string; The first name of the applicant.
  • PersonLastName; string; The last name of the applicant.
  • PlannerName; string; The name of the planner assigned to the planning and zoning application.
  • PostalCode; string; The postal code for the primary parcel address of the record.
  • PrimaryHearingBodyName; string; The name of the primary hearing body of the record.
  • RecordType; string; The type of the planning and zoning application.
  • RecordTypeId; string; The unique identifier of the type of the planning and zoning application.
  • ScheduleDatetime; string; The date and time of the hearing schedule.
  • ScheduleOrder; integer; The order of the hearings scheduled for a day.
  • ScheduleStatus; string; The status of the hearing schedule.
  • SequenceAction; string; The hearing sequence action of the record.
  • SequenceActionDatetime; string; The date and time of the hearing sequence of the record.
  • StaffDecisionName; string; The staff decision name.
  • State; string; The state for the primary parcel address of the record.
  • Status; string; The hearing schedule status.
  • Subclassification; string; The subclassification of the planning and zoning application.
• 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 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 : publicSectorScheduledHearings

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorScheduledHearings-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"PlanningandZoning",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorScheduledHearings-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorScheduledHearings-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 : publicSectorScheduledHearings-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  The first line for the primary parcel address of the record.
• Address2: string
  Read Only: true

  The second line for the primary parcel address of the record.
• Address3: string
  Read Only: true

  The third line for the primary parcel address of the record.
• Address4: string
  Read Only: true

  The fourth line for the primary parcel address of the record.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  Default Value: 1

  The unique identifier of the agency.
• CancelAccess: array Cancel Accesses
  Title: Cancel Accesses

  The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing.
• City: string
  Read Only: true

  The city for the primary parcel address of the record.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The classification of the of the planning and zoning application.
• Country: string
  Read Only: true

  The country for the primary parcel address of the record.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The description of the planning and zoning application.
• EventDecision: string
  Title: Decision

  Read Only: true

  Maximum Length: 15

  The hearing event decision code.
• EventDecisionDatetime: string (date-time)
  Read Only: true

  The date and time of the hearing event decision.
• EventStatus: string
  Title: Decision Status

  Read Only: true

  Maximum Length: 15

  Default Value: ORA_NOTSTRTD

  The hearing event status.
• HearingBodyCode: string
  Title: Hearing Body Code

  Read Only: true

  Maximum Length: 60

  The unique identifier of the hearing body.
• HearingBodyName: string
  Title: Hearing Body

  Read Only: true

  Maximum Length: 255

  The hearing body name.
• HearingDecisionCode: string
  Title: Decision

  Read Only: true

  Maximum Length: 15

  The hearing decision code.
• HearingDecisionName: string
  Title: Hearing Decision

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The unique identifier of the hearing event record.
• HearingHierarchyCode: string
  Title: Hierarchy Code

  Read Only: true

  Maximum Length: 60

  The hearing hierarchy code of the 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
  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.
• ManageAccess: array Manage Accesses
  Title: Manage Accesses

  The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing.
• ParentEventKey: integer (int64)
  Read Only: true

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

  The unique identifier of the parent hearing sequence.
• PermitAssignedId: integer
  Title: Permit Assignee ID

  Read Only: true

  The unique identifier of the planner assigned to the permit.
• 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.
• PlannerName: string
  Title: Assigned Planner Name

  Read Only: true

  Maximum Length: 255

  The name of the planner assigned to the planning and zoning application.
• PostalCode: string
  Read Only: true

  The postal code for the primary parcel address of the record.
• PrimaryHearingBodyName: string
  Read Only: true

  Maximum Length: 255

  The name of the primary hearing body of the record.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The type of the planning and zoning application.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the type of the planning and zoning application.
• ScheduleDatetime: string (date-time)
  Title: Decision Date

  Read Only: true

  The date and time of the hearing schedule.
• ScheduleOrder: integer (int32)
  Read Only: true

  Default Value: 0

  The order of the hearings scheduled for a day.
• ScheduleStatus: string
  Title: Schedule Status

  Read Only: true

  Maximum Length: 15

  Default Value: ORA_UNSCHLD

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

  Read Only: true

  Maximum Length: 15

  The hearing sequence action of the record.
• SequenceActionDatetime: string (date-time)
  Read Only: true

  The date and time of the hearing sequence of the record.
• StaffDecisionName: string
  Title: Staff Decision

  Read Only: true

  Maximum Length: 255

  The staff decision name.
• State: string
  Read Only: true

  The state for the primary parcel address of the record.
• Status: string
  Title: Hearing Status

  Read Only: true

  Maximum Length: 15

  The hearing schedule status.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

  The subclassification of the planning and zoning application.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification of the planning and zoning application.",
            "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
        },
        "SequenceActionDatetime":{
            "type":"string",
            "description":"The date and time of the hearing sequence of the record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionCode":{
            "title":"Decision",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing decision code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the planning and zoning application.",
            "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
        },
        "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
        },
        "ParentEventKey":{
            "type":"integer",
            "description":"The unique identifier of the parent hearing event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManageAccess":{
            "title":"Manage Accesses",
            "type":"array",
            "description":"The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing.",
            "items":{
                "$ref":"#/components/schemas/publicSectorScheduledHearings-ManageAccess-item-response"
            },
            "x-cardinality":"1"
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the hearing body.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventStatus":{
            "title":"Decision Status",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing event status.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_NOTSTRTD",
            "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
        },
        "PlannerName":{
            "title":"Assigned Planner Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the planner assigned to the planning and zoning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "type":"string",
            "description":"The postal code for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitAssignedId":{
            "title":"Permit Assignee ID",
            "type":"integer",
            "description":"The unique identifier of the planner assigned to the permit.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "StaffDecisionName":{
            "title":"Staff Decision",
            "maxLength":"255",
            "type":"string",
            "description":"The staff decision name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The type of the planning and zoning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "type":"string",
            "description":"The fourth line for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the of the planning and zoning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the type of the planning and zoning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecisionName":{
            "title":"Hearing Decision",
            "maxLength":"255",
            "type":"string",
            "description":"The hearing decision name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SequenceAction":{
            "title":"Hearing Outcome",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing sequence action of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Hearing Status",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing schedule status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the planning and zoning application.",
            "nullable":false,
            "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
        },
        "EventDecision":{
            "title":"Decision",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing event decision code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "type":"string",
            "description":"The second line for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleOrder":{
            "type":"integer",
            "description":"The order of the hearings scheduled for a day.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "Address3":{
            "type":"string",
            "description":"The third line for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "type":"string",
            "description":"The first line for the primary parcel address of the record.",
            "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
        },
        "City":{
            "type":"string",
            "description":"The city for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingHierarchyCode":{
            "title":"Hierarchy Code",
            "maxLength":"60",
            "type":"string",
            "description":"The hearing hierarchy code of the record.",
            "nullable":false,
            "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
        },
        "HearingBodyName":{
            "title":"Hearing Body",
            "maxLength":"255",
            "type":"string",
            "description":"The hearing body name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelAccess":{
            "title":"Cancel Accesses",
            "type":"array",
            "description":"The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing.",
            "items":{
                "$ref":"#/components/schemas/publicSectorScheduledHearings-CancelAccess-item-response"
            },
            "x-cardinality":"1"
        },
        "ParentSequenceKey":{
            "type":"integer",
            "description":"The unique identifier of the parent hearing sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventDecisionDatetime":{
            "type":"string",
            "description":"The date and time of the hearing event decision.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "type":"string",
            "description":"The state for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "type":"string",
            "description":"The country for the primary parcel address of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleStatus":{
            "title":"Schedule Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the hearing schedule.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_UNSCHLD",
            "x-queryable":true
        },
        "PrimaryHearingBodyName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the primary hearing body of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Cancel Accesses

Type: array

Title: Cancel Accesses

The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing.

Show Source

• Array of: object publicSectorScheduledHearings-CancelAccess-item-response

{
    "title":"Cancel Accesses",
    "type":"array",
    "description":"The cancel access resource is used to view the cancel access of a scheduled hearing. Cancel access is to let you know if you are allowed to cancel a scheduled hearing.",
    "items":{
        "$ref":"#/components/schemas/publicSectorScheduledHearings-CancelAccess-item-response"
    },
    "x-cardinality":"1"
}

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 : Manage Accesses

Type: array

Title: Manage Accesses

The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing.

Show Source

• Array of: object publicSectorScheduledHearings-ManageAccess-item-response

{
    "title":"Manage Accesses",
    "type":"array",
    "description":"The manage access resource is used to view the manage access of a scheduled hearing. Manage access is to let you know your access to manage a scheduled hearing.",
    "items":{
        "$ref":"#/components/schemas/publicSectorScheduledHearings-ManageAccess-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : publicSectorScheduledHearings-CancelAccess-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the planning and zoning application.

{
    "type":"object",
    "properties":{
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : publicSectorScheduledHearings-ManageAccess-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the planning and zoning application.

{
    "type":"object",
    "properties":{
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Back to Top