1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Common Setup
  4. Parcels

Get all parcels

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcels

Request

Query Parameters
  • 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:

    • AltKey: Finds a parcel that matches the specified alternate key criteria.
      Finder Variables:
      • ParcelIdEntered; string; The unique identifier for the parcel.
    • PrimaryKey: Finds a parcel that matches the specified primary key criteria.
      Finder Variables:
      • ParcelId; integer; The unique identifier for the parcel.
    • simpleSearchFinder: Finds a parcel that matches the specified value.
      Finder Variables:
      • value; string; The unique identifier for the 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.
    • Bathrooms; string; The number of bathrooms for the building on the parcel.
    • Bedrooms; string; The number of bedrooms for the building on the parcel.
    • BlockNumber; string; The block number of the parcel.
    • BookNumber; string; The book number of the parcel.
    • BoundaryDescription; string; The boundary description of the parcel.
    • CensusBlock; string; The neighbourhood information related to the location of the parcel.
    • CensusTract; string; The neighbourhood information related to the location of the parcel.
    • ClimateZone; string; The detailed climate zone of the parcel.
    • CoordinateX; number; Indicates the x coordinate of the parcel.
    • CoordinateY; number; Indicates the y coordinate of the parcel.
    • DwellingUnitCount; integer; The number of dwelling units for the parcel.
    • EnabledFlag; boolean; Indicates whether the parcel is available to be used. The default value is N.
    • FinalParcelIdEntered; string; The final parcel number.
    • FireRisk; string; The fire risk associated with the parcel.
    • FloodInsRateMap; string; The flood insurance rate map related to the parcel location for floodplain management and insurance purposes.
    • FloodZone; string; The detailed flood zone of the parcel.
    • GeneralPlanTwo; string; The alternate land Information of the parcel.
    • Jurisdiction; string; The jurisdiction of the parcel.
    • LandUseCode; string; The land use code of the parcel.
    • LandslideRisk; string; The landslide risk associated with the parcel.
    • Latitude; number; The latitude of the parcel.
    • LiquefactionRisk; string; The liquefaction risk associated with the parcel.
    • Longitude; number; The longitude of the parcel.
    • LotNumber; string; The lot number of the parcel.
    • MapBookPage; string; Tthe map book page of the parcel.
    • MapName; string; The map name of the parcel.
    • PageNumber; string; The page number of the parcel.
    • ParcelId; integer; The unique identifier for the parcel.
    • ParcelIdEntered; string; The parcel number.
    • 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 can be either Final or Provisional.
    • ParcelType; string; The type of parcel.
    • ParcelUnitNumber; string; The unit number of the parcel.
    • ParentParcelId; integer; The unique identifier for the parent of the parcel.
    • Patio; string; The information about patios located on the parcel.
    • Pool; string; The information about pools located on the parcel.
    • PrimaryZoningId; string; The unique identifier for the primary zoning of the parcel.
    • PropertyDescription; string; The property description of the parcel.
    • ProvParcelIdEntered; string; The provisional parcel number.
    • SectionNumber; string; The section number of the parcel.
    • SoilType; string; The soil type associated with the parcel.
    • Srid; integer; The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.
    • 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.
    • TaxRateArea; string; The area identifier of the parcel location for taxation purposes.
    • YearBuilt; string; The year in which the building on the parcel was built.
    • ZoningCodeTwo; string; The secondary code of the zoning related to the parcel.
    • ZoningDescription; string; The zoning description of the parcel.
  • 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 : publicSectorParcels
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorParcels-item-response
Type: object
Show Source
Back to Top