Jump to

• Request
• Response

Get a record parcel and related parcel information

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/{ParcelKey}

Request

Path Parameters

• ParcelKey(required): integer(int64)
  The unique identifier for a parcel.

Query Parameters

• dependency: string
  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>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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 : publicSectorParcelProperties-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for a public sector agency associated with the parcel address.
• BlockNumber: 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: 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: 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.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 50

  The district name of the parcel.
• FixtureExemption: number
  Title: Fixture Exemption

  Read Only: true

  The exempted fixture information of the parcel.
• Fixtures: number
  Title: Fixtures

  Read Only: true

  The fixtures associated with the parcel.
• ImprovementValue: number
  Title: Improvement Value

  Read Only: true

  The improvement value of the parcel.
• Jurisdiction: string
  Title: Jurisdiction

  Maximum Length: 50

  The name of the city, if incorporated, or the name of the county, if unincorporated.
• LandUseCode: 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).
• LandValue: number
  Title: Land Value

  Read Only: true

  The land value of the parcel.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  The geographic location of the parcel 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

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

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

  The geographic location of the parcel that is north or south of the equator.
• LotNumber: 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: string
  Title: Map Book Page

  Maximum Length: 50

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

  Maximum Length: 50

  The recorded map name. For example, Public Works.
• NetAssessedValues: number
  Title: Net Assessed Value

  Read Only: true

  The net assessed value of the parcel.
• OtherExemption: number
  Title: Other Exemption

  Read Only: true

  Any additional exemptions for the parcel.
• OwnerExemption: number
  Title: Owner Exemption

  Read Only: true

  The exempted owner information of the parcel.
• PageNumber: 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: integer (int64)
  Title: Parcel

  The unique identifier of the record parcel.
• ParcelIdEntered: string
  Title: Parcel

  Maximum Length: 50

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

  The unique identifier for a parcel.
• ParcelSizeOne: number
  Title: Parcel Size

  Read Only: true

  The first parcel size.
• ParcelSizeOneUOM: string
  Read Only: true

  Maximum Length: 3

  The unit of measure for the first parcel size.
• ParcelType: string
  Title: Parcel Type

  Maximum Length: 30

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

  The unique identifier for the parent record parcel.
• PersonalPropertyValue: number
  Title: Personal Property Value

  Read Only: true

  The personal property value of the parcel.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
• PrimaryParcelAddress: string
  Read Only: true

  Maximum Length: 240

  The address of the primary parcel address.
• PrimaryParcelCity: string
  Read Only: true

  Maximum Length: 60

  The city in the primary parcel address.
• PrimaryParcelState: string
  Read Only: true

  Maximum Length: 6

  The state in the primary parcel address.
• PrimaryZoningId: string
  Title: Primary Zone

  Maximum Length: 30

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

  Maximum Length: 240

  The property description.
• SectionNumber: 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).
• Srid: integer (int64)
  Title: SRID

  The GIS coordinate system in use.
• Subdivision: 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).
• UnitNumber: 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).
• ZoningDescription: string
  Title: Zone Description

  Maximum Length: 240

  The zoning description.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record parcel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "BookNumber":{
            "title":"Book",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for a public sector agency associated with the parcel address.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "SectionNumber":{
            "title":"Section",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "ImprovementValue":{
            "title":"Improvement Value",
            "type":"number",
            "description":"The improvement value of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The geographic location of the parcel 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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelSizeOne":{
            "title":"Parcel Size",
            "type":"number",
            "description":"The first parcel size.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":20,
                "scale":5
            },
            "x-queryable":true
        },
        "FixtureExemption":{
            "title":"Fixture Exemption",
            "type":"number",
            "description":"The exempted fixture information of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "ParentParcelId":{
            "title":"Parent Parcel",
            "type":"integer",
            "description":"The unique identifier for the parent record parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryParcelAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The address of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryParcelState":{
            "maxLength":6,
            "type":"string",
            "description":"The state in the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PageNumber":{
            "title":"Page",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "MapBookPage":{
            "title":"Map Book Page",
            "maxLength":50,
            "type":"string",
            "description":"The recorded map book and page.",
            "nullable":true,
            "x-queryable":true
        },
        "NetAssessedValues":{
            "title":"Net Assessed Value",
            "type":"number",
            "description":"The net assessed value of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel",
            "maxLength":50,
            "type":"string",
            "description":"The Assessor Parcel Number (APN) as entered by the user.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "title":"Parcel Key",
            "type":"integer",
            "description":"The unique identifier for a parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the parcel. For example, commercial, residential, or government.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the application record.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The unique identifier of the record parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerExemption":{
            "title":"Owner Exemption",
            "type":"number",
            "description":"The exempted owner information of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "OtherExemption":{
            "title":"Other Exemption",
            "type":"number",
            "description":"Any additional exemptions for the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "Subdivision":{
            "title":"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).",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier for the record associated with the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The geographic location of the parcel that is north or south of the equator.",
            "nullable":true,
            "x-queryable":true
        },
        "ZoningDescription":{
            "title":"Zone Description",
            "maxLength":240,
            "type":"string",
            "description":"The zoning description.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonalPropertyValue":{
            "title":"Personal Property Value",
            "type":"number",
            "description":"The personal property value of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "Jurisdiction":{
            "title":"Jurisdiction",
            "maxLength":50,
            "type":"string",
            "description":"The name of the city, if incorporated, or the name of the county, if unincorporated.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictName":{
            "title":"District",
            "maxLength":50,
            "type":"string",
            "description":"The district name of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "MapName":{
            "title":"Map Name",
            "maxLength":50,
            "type":"string",
            "description":"The recorded map name. For example, Public Works.",
            "nullable":true,
            "x-queryable":true
        },
        "Fixtures":{
            "title":"Fixtures",
            "type":"number",
            "description":"The fixtures associated with the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "LandValue":{
            "title":"Land Value",
            "type":"number",
            "description":"The land value of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":30,
                "scale":4
            },
            "x-queryable":true
        },
        "PrimaryParcelCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelSizeOneUOM":{
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure for the first parcel size.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BlockNumber":{
            "title":"Block",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"The GIS coordinate system in use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "LandUseCode":{
            "title":"Land Use",
            "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).",
            "nullable":true,
            "x-queryable":true
        },
        "BoundaryDescription":{
            "title":"Boundary Description",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryZoningId":{
            "title":"Primary Zone",
            "maxLength":30,
            "type":"string",
            "description":"The primary zoning ID of the zoning for the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record parcel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Back to Top