Get all permit parcels

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel

Request

Path Parameters
  • The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 a permit parcel using the primary key criteria.
      Finder Variables:
      • ParcelKey; integer; The unique identifier for a permit parcel.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AdditionalStructure; string; The information about additional structures located on the parcel.
    • AgencyId; integer; The unique identifier for the public sector agency associated with the parcel.
    • Bathrooms; string; The number of bathrooms in the building on the parcel.
    • Bedrooms; string; The number of bedrooms in the building on the parcel.
    • BlockNumber; string; The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • BookNumber; string; The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • BoundaryDescription; string; A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206.
    • CensusBlock; string; The neighborhood information related to the location of the parcel.
    • CensusTract; string; The neighborhood information related to the location of the parcel.
    • ClimateZone; string; The climate zone information of the parcel.
    • CoordinateX; number; The x-axis coordinate for the record parcel.
    • CoordinateY; number; The y-axis coordinate for the record parcel.
    • CreationDate; string; The date when the record parcel was created.
    • DistrictName; string; The district name of the parcel.
    • DwellingUnitCount; integer; The count of dwelling units in the record parcel.
    • FireRisk; string; The fire risk information related to the parcel.
    • FloodInsRateMap; string; The Flood Insurance Rate Map related to the parcel.
    • FloodZone; string; The detailed land information of the parcel.
    • GeneralPlanTwo; string; The alternate plan information of the parcel.
    • Jurisdiction; string; The name of the city, if incorporated, or the name of the county, if unincorporated.
    • LandUseCode; string; The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • LandslideRisk; string; The landslide risk information related to the parcel.
    • LastUpdateDate; string; The date when the record parcel was last updated.
    • Latitude; number; The geographic location of the parcel that is north or south of the equator.
    • LiquefactionRisk; string; The liquefaction risk information of the parcel.
    • LnpRecordId; string; The unique identifier for the application record.
    • LnpRecordKey; integer; The unique identifier for the record associated with the parcel.
    • Longitude; number; The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
    • LotNumber; string; The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • MapBookPage; string; The recorded map book and page.
    • MapName; string; The recorded map name. For example, Public Works.
    • PageNumber; string; The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • ParcelId; integer; The identifier of the record parcel.
    • ParcelIdEntered; string; The Assessor Parcel Number (APN) as entered by the user.
    • ParcelKey; integer; The unique identifier for the parcel associated with a parcel address.
    • ParcelSizeOne; number; The first parcel size.
    • ParcelSizeOneUnit; string; The unit of measure for the first parcel size.
    • ParcelSizeTwo; number; The second parcel size.
    • ParcelSizeTwoUnit; string; The unit of measure for the second parcel size.
    • ParcelStatus; string; The status of the parcel, which is Final or Provisional.
    • ParcelType; string; The type of the parcel. For example, commercial, residential, or government.
    • ParentParcelId; integer; The unique identifier of the parent record parcel.
    • Patio; string; The information about patios located on the parcel.
    • Pool; string; The information about pools located on the parcel.
    • PrimaryFlag; boolean; Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N.
    • PrimaryZoningId; string; The primary zoning ID of the zoning for the parcel.
    • PropertyDescription; string; The property description.
    • SectionNumber; string; The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • Shape; object; The Oracle spatial field of a record parcel, which is the storage field for shape data.
    • SoilType; string; The soil type information of the parcel.
    • Srid; integer; The GIS coordinate system in use.
    • StructureSizeOne; number; The first structure size.
    • StructureSizeOneUnit; string; The unit of measure for the first structure size.
    • StructureSizeTwo; number; The second structure size.
    • StructureSizeTwoUnit; string; The unit of measure for the second structure size.
    • Subdivision; string; The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • TaxRateArea; string; The area Identifier of the parcel location for tax purposes.
    • UnitNumber; string; The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
    • YearBuilt; string; The year in which the building on the parcel was built.
    • ZoningCodeTwo; string; The secondary zoning code of the parcel.
    • ZoningDescription; string; The zoning description.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorRecordQueries-RecordParcel
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorRecordQueries-RecordParcel-item-response
Type: object
Show Source
Nested Schema : Parcel Addresses
Type: array
Title: Parcel Addresses
The parcel addresses resource is used to view the parcel addresses.
Show Source
Nested Schema : Parcel Owners
Type: array
Title: Parcel Owners
The parcel owners resource is used to view the parcel owners.
Show Source
Nested Schema : Shape
Type: object
The Oracle spatial field of a record parcel, which is the storage field for shape data.
Nested Schema : publicSectorRecordQueries-RecordParcel-ParcelAddress-item-response
Type: object
Show Source
Nested Schema : publicSectorRecordQueries-RecordParcel-ParcelOwner-item-response
Type: object
Show Source
Back to Top