Get a parcel
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcels/{ParcelId}
Request
Path Parameters
-
ParcelId: integer
The unique identifier for the parcel.
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorParcels-item
Type:
Show Source
object
-
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. -
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. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the parcel. -
CreationDate(optional):
string(date-time)
The date and time that the parcel was created.
-
DwellingUnitCount(optional):
integer(int64)
Title:
Number of Dwelling Units
The number of dwelling units for the parcel. -
EnabledFlag(optional):
boolean
Indicates whether the parcel is available to be used. The default value is N.
-
Jurisdiction(optional):
string
Title:
Jurisdiction
Maximum Length:50
The jurisdiction of the parcel. -
LandUseCode(optional):
string
Title:
Land Use Code
Maximum Length:30
The land use code of the parcel. -
LastUpdateDate(optional):
string(date-time)
The date and time that the parcel was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the parcel. -
Latitude(optional):
number
Title:
Latitude
The latitude of the parcel. -
links(optional):
array Items
Title:
Items
Link Relations -
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
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
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. -
PrimaryZoningId(optional):
string
Title:
Primary Zoning ID
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. -
SectionNumber(optional):
string
Title:
Section Number
Maximum Length:30
The section number of 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. -
ZoningDescription(optional):
string
Title:
Zoning Description
Maximum Length:240
The zoning description of the parcel.
Nested Schema : link
Type:
Show Source
object
-
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.