Jump to

• Request
• Response

Get all parcels

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcels

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • simpleSearchFinder: Finds a parcel that matches the specified value. Finder Variables:
    • value; 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.
  • AltKey: Finds a parcel that matches the specified alternate key criteria. Finder Variables:
    • ParcelIdEntered; string; The unique identifier for the parcel.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorParcels

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorParcels-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorParcels-item

{
    "items":{
        "$ref":"#/definitions/publicSectorParcels-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorParcels-item

Type: object

Show Source

• AdditionalStructure(optional): string
  Title: Additional Structure

  Maximum Length: 200

  The information about additional structures located on the parcel.
• Bathrooms(optional): string
  Title: Bathrooms

  Maximum Length: 20

  The number of bathrooms for the building on the parcel.
• Bedrooms(optional): string
  Title: Bedrooms

  Maximum Length: 20

  The number of bedrooms for the building on the parcel.
• BlockNumber(optional): string
  Title: Block Number

  Maximum Length: 30

  The block number of the parcel.
• BookNumber(optional): string
  Title: Book Number

  Maximum Length: 30

  The book number of the parcel.
• BoundaryDescription(optional): string
  Title: Boundary Description

  Maximum Length: 480

  The boundary description of the parcel.
• CensusBlock(optional): string
  Title: Census Block

  Maximum Length: 100

  The neighbourhood information related to the location of the parcel.
• CensusTract(optional): string
  Title: Census Tract

  Maximum Length: 100

  The neighbourhood information related to the location of the parcel.
• ClimateZone(optional): string
  Title: Climate Zone

  Maximum Length: 200

  The detailed climate zone of the parcel.
• CoordinateX(optional): number
  Title: X Coordinate

  Indicates the x coordinate of the parcel.
• CoordinateY(optional): number
  Title: Y Coordinate

  Indicates the y coordinate of the parcel.
• DwellingUnitCount(optional): integer(int64)
  Title: Number of Dwelling Units

  The number of dwelling units for the parcel.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the parcel is available to be used. The default value is N.
• FinalParcelIdEntered(optional): string
  Maximum Length: 30

  The final parcel number.
• FireRisk(optional): string
  Title: Fire Risk

  Maximum Length: 200

  The fire risk associated with the parcel.
• FloodInsRateMap(optional): string
  Title: Flood Insurance Rate Map

  Maximum Length: 200

  The flood insurance rate map related to the parcel location for floodplain management and insurance purposes.
• FloodZone(optional): string
  Title: Flood Zone

  Maximum Length: 200

  The detailed flood zone of the parcel.
• GeneralPlanTwo(optional): string
  Title: General Plan 2

  Maximum Length: 30

  The alternate land Information of the parcel.
• Jurisdiction(optional): string
  Title: Jurisdiction

  Maximum Length: 50

  The jurisdiction of the parcel.
• LandslideRisk(optional): string
  Title: Landslide Risk

  Maximum Length: 200

  The landslide risk associated with the parcel.
• LandUseCode(optional): string
  Title: General Plan

  Maximum Length: 30

  The land use code of the parcel.
• Latitude(optional): number
  Title: Latitude

  The latitude of the parcel.
• links(optional): array Items
  Title: Items

  Link Relations
• LiquefactionRisk(optional): string
  Title: Liquefaction Risk

  Maximum Length: 200

  The liquefaction risk associated with the parcel.
• Longitude(optional): number
  Title: Longitude

  The longitude of the parcel.
• LotNumber(optional): string
  Title: Lot Number

  Maximum Length: 30

  The lot number of the parcel.
• MapBookPage(optional): string
  Title: Map Book Page

  Maximum Length: 50

  Tthe map book page of the parcel.
• MapName(optional): string
  Title: Map Name

  Maximum Length: 50

  The map name of the parcel.
• PageNumber(optional): string
  Title: Page Number

  Maximum Length: 30

  The page number of the parcel.
• ParcelId(optional): integer(int64)
  Title: Parcel ID

  The unique identifier for the parcel.
• ParcelIdEntered(optional): string
  Title: Parcel Number

  Maximum Length: 30

  The parcel number.
• ParcelSizeOne(optional): number
  Title: Parcel Size 1

  The first parcel size.
• ParcelSizeOneUnit(optional): string
  Title: Parcel Size 1 UOM

  Maximum Length: 10

  The unit of measure for the first parcel size.
• ParcelSizeTwo(optional): number
  Title: Parcel Size 2

  The second parcel size.
• ParcelSizeTwoUnit(optional): string
  Title: Parcel Size 2 UOM

  Maximum Length: 10

  The unit of measure for the second parcel size.
• ParcelStatus(optional): string
  Title: Status

  Maximum Length: 20

  The status of the parcel which can be either Final or Provisional.
• ParcelType(optional): string
  Title: Parcel Type

  Maximum Length: 30

  The type of parcel.
• ParcelUnitNumber(optional): string
  Title: Unit Number

  Maximum Length: 30

  The unit number of the parcel.
• ParentParcelId(optional): integer(int64)
  Title: Parent Parcel ID

  The unique identifier for the parent of the parcel.
• Patio(optional): string
  Title: Patio

  Maximum Length: 200

  The information about patios located on the parcel.
• Pool(optional): string
  Title: Pool

  Maximum Length: 200

  The information about pools located on the parcel.
• PrimaryZoningId(optional): string
  Title: Zoning Code

  Maximum Length: 30

  The unique identifier for the primary zoning of the parcel.
• PropertyDescription(optional): string
  Title: Property Description

  Maximum Length: 240

  The property description of the parcel.
• ProvParcelIdEntered(optional): string
  Maximum Length: 30

  The provisional parcel number.
• SectionNumber(optional): string
  Title: Section Number

  Maximum Length: 30

  The section number of the parcel.
• SoilType(optional): string
  Title: Soil Type

  Maximum Length: 200

  The soil type associated with the parcel.
• Srid(optional): integer(int64)
  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(optional): number
  Title: Structure Size 1

  The first structure size.
• StructureSizeOneUnit(optional): string
  Title: Structure Size 1 UOM

  Maximum Length: 10

  The unit of measure for the first structure size.
• StructureSizeTwo(optional): number
  Title: Structure Size 2

  The second structure size.
• StructureSizeTwoUnit(optional): string
  Title: Structure Size 2 UOM

  Maximum Length: 10

  The unit of measure for the second structure size.
• Subdivision(optional): string
  Title: Subdivision

  Maximum Length: 30

  The subdivision of the parcel.
• TaxRateArea(optional): string
  Title: Tax Rate Area

  Maximum Length: 100

  The area identifier of the parcel location for taxation purposes.
• YearBuilt(optional): string
  Title: Year Built

  Maximum Length: 4

  The year in which the building on the parcel was built.
• ZoningCodeTwo(optional): string
  Title: Zoning Code 2

  Maximum Length: 30

  The secondary code of the zoning related to the parcel.
• ZoningDescription(optional): string
  Title: Zoning Description

  Maximum Length: 240

  The zoning description of the parcel.

{
    "properties":{
        "AdditionalStructure":{
            "maxLength":200,
            "type":"string",
            "description":"The information about additional structures located on the parcel.",
            "title":"Additional Structure"
        },
        "Bathrooms":{
            "maxLength":20,
            "type":"string",
            "description":"The number of bathrooms for the building on the parcel.",
            "title":"Bathrooms"
        },
        "Bedrooms":{
            "maxLength":20,
            "type":"string",
            "description":"The number of bedrooms for the building on the parcel.",
            "title":"Bedrooms"
        },
        "BlockNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The block number of the parcel.",
            "title":"Block Number"
        },
        "BookNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The book number of the parcel.",
            "title":"Book Number"
        },
        "BoundaryDescription":{
            "maxLength":480,
            "type":"string",
            "description":"The boundary description of the parcel.",
            "title":"Boundary Description"
        },
        "CensusBlock":{
            "maxLength":100,
            "type":"string",
            "description":"The neighbourhood information related to the location of the parcel.",
            "title":"Census Block"
        },
        "CensusTract":{
            "maxLength":100,
            "type":"string",
            "description":"The neighbourhood information related to the location of the parcel.",
            "title":"Census Tract"
        },
        "ClimateZone":{
            "maxLength":200,
            "type":"string",
            "description":"The detailed climate zone of the parcel.",
            "title":"Climate Zone"
        },
        "CoordinateX":{
            "type":"number",
            "description":"Indicates the x coordinate of the parcel.",
            "title":"X Coordinate"
        },
        "CoordinateY":{
            "type":"number",
            "description":"Indicates the y coordinate of the parcel.",
            "title":"Y Coordinate"
        },
        "DwellingUnitCount":{
            "format":"int64",
            "type":"integer",
            "description":"The number of dwelling units for the parcel.",
            "title":"Number of Dwelling Units"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel is available to be used. The default value is N.",
            "title":"Enabled"
        },
        "FinalParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The final parcel number."
        },
        "FireRisk":{
            "maxLength":200,
            "type":"string",
            "description":"The fire risk associated with the parcel.",
            "title":"Fire Risk"
        },
        "FloodInsRateMap":{
            "maxLength":200,
            "type":"string",
            "description":"The flood insurance rate map related to the parcel location for floodplain management and insurance purposes.",
            "title":"Flood Insurance Rate Map"
        },
        "FloodZone":{
            "maxLength":200,
            "type":"string",
            "description":"The detailed flood zone of the parcel.",
            "title":"Flood Zone"
        },
        "GeneralPlanTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate land Information of the parcel.",
            "title":"General Plan 2"
        },
        "Jurisdiction":{
            "maxLength":50,
            "type":"string",
            "description":"The jurisdiction of the parcel.",
            "title":"Jurisdiction"
        },
        "LandUseCode":{
            "maxLength":30,
            "type":"string",
            "description":"The land use code of the parcel.",
            "title":"General Plan"
        },
        "LandslideRisk":{
            "maxLength":200,
            "type":"string",
            "description":"The landslide risk associated with the parcel.",
            "title":"Landslide Risk"
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the parcel.",
            "title":"Latitude"
        },
        "LiquefactionRisk":{
            "maxLength":200,
            "type":"string",
            "description":"The liquefaction risk associated with the parcel.",
            "title":"Liquefaction Risk"
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the parcel.",
            "title":"Longitude"
        },
        "LotNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The lot number of the parcel.",
            "title":"Lot Number"
        },
        "MapBookPage":{
            "maxLength":50,
            "type":"string",
            "description":"Tthe map book page of the parcel.",
            "title":"Map Book Page"
        },
        "MapName":{
            "maxLength":50,
            "type":"string",
            "description":"The map name of the parcel.",
            "title":"Map Name"
        },
        "PageNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The page number of the parcel.",
            "title":"Page Number"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "title":"Parcel ID"
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel number.",
            "title":"Parcel Number"
        },
        "ParcelSizeOne":{
            "type":"number",
            "description":"The first parcel size.",
            "title":"Parcel Size 1"
        },
        "ParcelSizeOneUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the first parcel size.",
            "title":"Parcel Size 1 UOM"
        },
        "ParcelSizeTwo":{
            "type":"number",
            "description":"The second parcel size.",
            "title":"Parcel Size 2"
        },
        "ParcelSizeTwoUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the second parcel size.",
            "title":"Parcel Size 2 UOM"
        },
        "ParcelStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the parcel which can be either Final or Provisional.",
            "title":"Status"
        },
        "ParcelType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of parcel.",
            "title":"Parcel Type"
        },
        "ParcelUnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel.",
            "title":"Unit Number"
        },
        "ParentParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parent of the parcel.",
            "title":"Parent Parcel ID"
        },
        "Patio":{
            "maxLength":200,
            "type":"string",
            "description":"The information about patios located on the parcel.",
            "title":"Patio"
        },
        "Pool":{
            "maxLength":200,
            "type":"string",
            "description":"The information about pools located on the parcel.",
            "title":"Pool"
        },
        "PrimaryZoningId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the primary zoning of the parcel.",
            "title":"Zoning Code"
        },
        "PropertyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The property description of the parcel.",
            "title":"Property Description"
        },
        "ProvParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The provisional parcel number."
        },
        "SectionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The section number of the parcel.",
            "title":"Section Number"
        },
        "SoilType":{
            "maxLength":200,
            "type":"string",
            "description":"The soil type associated with the parcel.",
            "title":"Soil Type"
        },
        "Srid":{
            "format":"int64",
            "type":"integer",
            "description":"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":{
            "type":"number",
            "description":"The first structure size.",
            "title":"Structure Size 1"
        },
        "StructureSizeOneUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the first structure size.",
            "title":"Structure Size 1 UOM"
        },
        "StructureSizeTwo":{
            "type":"number",
            "description":"The second structure size.",
            "title":"Structure Size 2"
        },
        "StructureSizeTwoUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the second structure size.",
            "title":"Structure Size 2 UOM"
        },
        "Subdivision":{
            "maxLength":30,
            "type":"string",
            "description":"The subdivision of the parcel.",
            "title":"Subdivision"
        },
        "TaxRateArea":{
            "maxLength":100,
            "type":"string",
            "description":"The area identifier of the parcel location for taxation purposes.",
            "title":"Tax Rate Area"
        },
        "YearBuilt":{
            "maxLength":4,
            "type":"string",
            "description":"The year in which the building on the parcel was built.",
            "title":"Year Built"
        },
        "ZoningCodeTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The secondary code of the zoning related to the parcel.",
            "title":"Zoning Code 2"
        },
        "ZoningDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The zoning description of the parcel.",
            "title":"Zoning Description"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top