Jump to

• Request
• Response

Get all permit parcels

get

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

Request

Path Parameters

• LnpRecordKey: integer
  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

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

  • PrimaryKey: Finds a permit parcel using the primary key criteria. Finder Variables:
    • ParcelKey; integer; The unique identifier for a permit 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 : publicSectorRecordQueries-RecordParcel

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/publicSectorRecordQueries-RecordParcel-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 publicSectorRecordQueries-RecordParcel-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRecordQueries-RecordParcel-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 : publicSectorRecordQueries-RecordParcel-item

Type: object

Show Source

• AdditionalStructure(optional): string
  Maximum Length: 200

  The information about additional structures located on the parcel.
• AgencyId(optional): integer(int64)
  Title: Agency ID

  The unique identifier for the public sector agency associated with the parcel.
• Bathrooms(optional): string
  Maximum Length: 20

  The number of bathrooms in the building on the parcel.
• Bedrooms(optional): string
  Maximum Length: 20

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

  Maximum Length: 30

  The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• BookNumber(optional): string
  Title: Book

  Maximum Length: 30

  The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• BoundaryDescription(optional): string
  Title: Boundary Description

  Maximum Length: 480

  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(optional): string
  Maximum Length: 100

  The neighborhood information related to the location of the parcel.
• CensusTract(optional): string
  Maximum Length: 100

  The neighborhood information related to the location of the parcel.
• ClimateZone(optional): string
  Maximum Length: 200

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

  The x-axis coordinate for the record parcel.
• CoordinateY(optional): number
  Title: Coordinate Y

  The y-axis coordinate for the record parcel.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the record parcel was created.
• DistrictName(optional): string
  Title: District

  Maximum Length: 50

  The district name of the parcel.
• DwellingUnitCount(optional): integer(int64)
  The count of dwelling units in the record parcel.
• FireRisk(optional): string
  Maximum Length: 200

  The fire risk information related to the parcel.
• FloodInsRateMap(optional): string
  Maximum Length: 200

  The Flood Insurance Rate Map related to the parcel.
• FloodZone(optional): string
  Maximum Length: 200

  The detailed land information of the parcel.
• GeneralPlanTwo(optional): string
  Maximum Length: 30

  The alternate plan information of the parcel.
• Jurisdiction(optional): string
  Title: Jurisdiction

  Maximum Length: 50

  The name of the city, if incorporated, or the name of the county, if unincorporated.
• LandslideRisk(optional): string
  Maximum Length: 200

  The landslide risk information related to the parcel.
• LandUseCode(optional): string
  Title: Land Use

  Maximum Length: 30

  The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the record parcel was last updated.
• Latitude(optional): number
  Title: Latitude

  The geographic location of the parcel that is north or south of the equator.
• links(optional): array Items
  Title: Items

  Link Relations
• LiquefactionRisk(optional): string
  Maximum Length: 200

  The liquefaction risk information of the parcel.
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey(optional): integer(int64)
  Title: Record

  The unique identifier for the record associated with the parcel.
• Longitude(optional): number
  Title: Longitude

  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(optional): string
  Title: Lot

  Maximum Length: 30

  The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• MapBookPage(optional): string
  Title: Map Book Page

  Maximum Length: 50

  The recorded map book and page.
• MapName(optional): string
  Title: Map Name

  Maximum Length: 50

  The recorded map name. For example, Public Works.
• PageNumber(optional): string
  Title: Page

  Maximum Length: 30

  The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• ParcelId(optional): integer(int64)
  Title: Parcel

  The identifier of the record parcel.
• ParcelIdEntered(optional): string
  Title: Parcel

  Maximum Length: 30

  The Assessor Parcel Number (APN) as entered by the user.
• ParcelKey(optional): integer(int64)
  Title: Parcel Key

  The unique identifier for the parcel associated with a parcel address.
• ParcelSizeOne(optional): number
  The first parcel size.
• ParcelSizeOneUnit(optional): string
  Maximum Length: 10

  The unit of measure for the first parcel size.
• ParcelSizeTwo(optional): number
  The second parcel size.
• ParcelSizeTwoUnit(optional): string
  Maximum Length: 10

  The unit of measure for the second parcel size.
• ParcelStatus(optional): string
  Maximum Length: 20

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

  Maximum Length: 30

  The type of the parcel. For example, commercial, residential, or government.
• ParentParcelId(optional): integer(int64)
  Title: Parent Parcel

  The unique identifier of the parent record parcel.
• Patio(optional): string
  Maximum Length: 200

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

  The information about pools located on the parcel.
• PrimaryFlag(optional): boolean
  Title: Primary

  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(optional): string
  Title: Primary Zone

  Maximum Length: 30

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

  Maximum Length: 240

  The property description.
• SectionNumber(optional): string
  Title: Section

  Maximum Length: 30

  The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• ShapeJson(optional): string
  The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.
• SoilType(optional): string
  Maximum Length: 200

  The soil type information of the parcel.
• Srid(optional): integer(int64)
  Title: SRID

  The GIS coordinate system in use.
• StructureSizeOne(optional): number
  The first structure size.
• StructureSizeOneUnit(optional): string
  Maximum Length: 10

  The unit of measure for the first structure size.
• StructureSizeTwo(optional): number
  The second structure size.
• StructureSizeTwoUnit(optional): string
  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 in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• TaxRateArea(optional): string
  Maximum Length: 100

  The area Identifier of the parcel location for tax purposes.
• UnitNumber(optional): string
  Title: Unit

  Maximum Length: 30

  The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
• YearBuilt(optional): string
  Maximum Length: 4

  The year in which the building on the parcel was built.
• ZoningCodeTwo(optional): string
  Maximum Length: 30

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

  Maximum Length: 240

  The zoning description.

{
    "properties":{
        "AdditionalStructure":{
            "maxLength":200,
            "type":"string",
            "description":"The information about additional structures located on the parcel."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the parcel.",
            "title":"Agency ID"
        },
        "Bathrooms":{
            "maxLength":20,
            "type":"string",
            "description":"The number of bathrooms in the building on the parcel."
        },
        "Bedrooms":{
            "maxLength":20,
            "type":"string",
            "description":"The number of bedrooms in the building on the parcel."
        },
        "BlockNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Block"
        },
        "BookNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Book"
        },
        "BoundaryDescription":{
            "maxLength":480,
            "type":"string",
            "description":"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.",
            "title":"Boundary Description"
        },
        "CensusBlock":{
            "maxLength":100,
            "type":"string",
            "description":"The neighborhood information related to the location of the parcel."
        },
        "CensusTract":{
            "maxLength":100,
            "type":"string",
            "description":"The neighborhood information related to the location of the parcel."
        },
        "ClimateZone":{
            "maxLength":200,
            "type":"string",
            "description":"The climate zone information of the parcel."
        },
        "CoordinateX":{
            "type":"number",
            "description":"The x-axis coordinate for the record parcel.",
            "title":"Coordinate X"
        },
        "CoordinateY":{
            "type":"number",
            "description":"The y-axis coordinate for the record parcel.",
            "title":"Coordinate Y"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record parcel was created.",
            "title":"Creation Date"
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The district name of the parcel.",
            "title":"District"
        },
        "DwellingUnitCount":{
            "format":"int64",
            "type":"integer",
            "description":"The count of dwelling units in the record parcel."
        },
        "FireRisk":{
            "maxLength":200,
            "type":"string",
            "description":"The fire risk information related to the parcel."
        },
        "FloodInsRateMap":{
            "maxLength":200,
            "type":"string",
            "description":"The Flood Insurance Rate Map related to the parcel."
        },
        "FloodZone":{
            "maxLength":200,
            "type":"string",
            "description":"The detailed land information of the parcel."
        },
        "GeneralPlanTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate plan information of the parcel."
        },
        "Jurisdiction":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the city, if incorporated, or the name of the county, if  unincorporated.",
            "title":"Jurisdiction"
        },
        "LandUseCode":{
            "maxLength":30,
            "type":"string",
            "description":"The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Land Use"
        },
        "LandslideRisk":{
            "maxLength":200,
            "type":"string",
            "description":"The landslide risk information related to the parcel."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record parcel was last updated.",
            "title":"Last Updated Date"
        },
        "Latitude":{
            "type":"number",
            "description":"The geographic location of the parcel that is north or south of the equator.",
            "title":"Latitude"
        },
        "LiquefactionRisk":{
            "maxLength":200,
            "type":"string",
            "description":"The liquefaction risk information of the parcel."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the application record.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the record associated with the parcel.",
            "title":"Record"
        },
        "Longitude":{
            "type":"number",
            "description":"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.",
            "title":"Longitude"
        },
        "LotNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Lot"
        },
        "MapBookPage":{
            "maxLength":50,
            "type":"string",
            "description":"The recorded map book and page.",
            "title":"Map Book Page"
        },
        "MapName":{
            "maxLength":50,
            "type":"string",
            "description":"The recorded map name. For example, Public Works.",
            "title":"Map Name"
        },
        "PageNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Page"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "title":"Parcel"
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The Assessor Parcel Number (APN) as entered by the user.",
            "title":"Parcel"
        },
        "ParcelKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel associated with a parcel address.",
            "title":"Parcel Key"
        },
        "ParcelSizeOne":{
            "type":"number",
            "description":"The first parcel size."
        },
        "ParcelSizeOneUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the first parcel size."
        },
        "ParcelSizeTwo":{
            "type":"number",
            "description":"The second parcel size."
        },
        "ParcelSizeTwoUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the second parcel size."
        },
        "ParcelStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the parcel, which is Final or Provisional."
        },
        "ParcelType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the parcel. For example, commercial, residential, or government.",
            "title":"Parcel Type"
        },
        "ParentParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the parent record parcel.",
            "title":"Parent Parcel"
        },
        "Patio":{
            "maxLength":200,
            "type":"string",
            "description":"The information about patios located on the parcel."
        },
        "Pool":{
            "maxLength":200,
            "type":"string",
            "description":"The information about pools located on the parcel."
        },
        "PrimaryFlag":{
            "type":"boolean",
            "description":"Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N.",
            "title":"Primary"
        },
        "PrimaryZoningId":{
            "maxLength":30,
            "type":"string",
            "description":"The primary zoning ID of the zoning for the parcel.",
            "title":"Primary Zone"
        },
        "PropertyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "title":"Property Description"
        },
        "SectionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Section"
        },
        "ShapeJson":{
            "type":"string",
            "description":"The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server."
        },
        "SoilType":{
            "maxLength":200,
            "type":"string",
            "description":"The soil type information of the parcel."
        },
        "Srid":{
            "format":"int64",
            "type":"integer",
            "description":"The GIS coordinate system in use.",
            "title":"SRID"
        },
        "StructureSizeOne":{
            "type":"number",
            "description":"The first structure size."
        },
        "StructureSizeOneUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the first structure size."
        },
        "StructureSizeTwo":{
            "type":"number",
            "description":"The second structure size."
        },
        "StructureSizeTwoUnit":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for the second structure size."
        },
        "Subdivision":{
            "maxLength":30,
            "type":"string",
            "description":"The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Subdivision"
        },
        "TaxRateArea":{
            "maxLength":100,
            "type":"string",
            "description":"The area Identifier of the parcel location for tax purposes."
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).",
            "title":"Unit"
        },
        "YearBuilt":{
            "maxLength":4,
            "type":"string",
            "description":"The year in which the building on the parcel was built."
        },
        "ZoningCodeTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The secondary zoning code of the parcel."
        },
        "ZoningDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The zoning description.",
            "title":"Zone 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