Create a set of project parcels
post
/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels
Request
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BlockNum: string
Title:
Block Number
Maximum Length:30
The block number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
BookNum: string
Title:
Book Number
Maximum Length:30
The book number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
The description of the property boundaries. The description is not a list of coordinates, it is a textual information about the boundaries. 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. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate value of the project parcel. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate value of the project parcel. -
DistrictName: string
Maximum Length:
50
The name of the district 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 Code
Maximum Length:30
The land use code of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
Latitude: number
Title:
Latitude
The geographic location value of the parcel that is to the north or south of the equator. -
Longitude: number
Title:
Longitude
The geographic location value of the parcel address that is to the east or west of the meridian. It typically points to a specific entrance area within a large parcel area, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
LotNum: string
Title:
Lot Number
Maximum Length:30
The lot number of the parcel in the Detail Land Information, which is a 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 name of the recorded map. For example, Public Works. -
PageNum: string
Title:
Page Number
Maximum Length:30
The page number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
ParcelId(required): integer
(int64)
Title:
Parcel ID
The identifier of the project parcel. -
ParcelIdEntered(required): string
Title:
Parcel ID
Maximum Length:30
The Assessor Parcel Number (APN) identifier as entered by the user. -
ParcelKey: integer
(int64)
The unique identifier of the project parcel.
-
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 ID
The unique identifier of the parent parcel. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the project parcel is the primary project parcel. The value 'Y' indicates that the parcel is the primary parcel and the value 'N' indicates that parcel is not the primary parcel. The default value is 'N'. -
PrimaryZoningId: string
Title:
Primary Zoning ID
Maximum Length:30
The primary identifier of the zoning for the parcel. -
PrjParcelOwner: array
Project Parcel Owners
Title:
Project Parcel Owners
The project parcel owners resource is used to create, view, and update the project parcel owners related to a project. -
ProjectAddress: array
Project Addresses
Title:
Project Addresses
The project addresses resource is used to create, view, and update the project parcel addresses related to a project. -
ProjectCode(required): string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The description of the property. -
SectionNum: string
Title:
Section Number
Maximum Length:30
The section number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
Srid: integer
(int64)
Title:
SRID
The GIS identifier coordinate system in use. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
UnitNum: string
Title:
Unit Number
Maximum Length:30
The unit number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
ZoningDescription: string
Title:
Zoning Description
Maximum Length:240
The description of the zoning.
Nested Schema : Project Parcel Owners
Type:
array
Title:
Project Parcel Owners
The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.
Show Source
Nested Schema : Project Addresses
Type:
array
Title:
Project Addresses
The project addresses resource is used to create, view, and update the project parcel addresses related to a project.
Show Source
Nested Schema : publicSectorProjectParcels-PrjParcelOwner-item-post-request
Type:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the project parcel owner, if available. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of the project parcel owner, if available. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the project parcel owner, if available. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The address field of the project parcel owner search. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The type of the building. For example, Tower A or Block 3.The building type of the project parcel owner search. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the project parcel owner. -
City: string
Title:
City
Maximum Length:60
The name of the city of the project parcel owner. -
Country: string
Title:
Country
Maximum Length:60
The name of the country of the project parcel owner. -
County: string
Title:
County
Maximum Length:60
The name of the county of the project parcel owner. -
DocumentNum: string
Title:
Document Number
Maximum Length:50
The document number of the project parcel owner. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the project parcel owner. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the project parcel owner. -
Floor: string
Title:
Floor
Maximum Length:20
The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the project parcel owner. -
Name1: string
Title:
Name 1
Maximum Length:150
The first name of the parcel owner. -
Name2: string
Title:
Name 2
Maximum Length:150
The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner ID
The unique identifier of the project parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of the parcel owner. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier of the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project parcel owner. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code of the project parcel owner. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the project parcel owner is the primary project parcel owner. The value 'Y' indicates that the parcel owner is the primary parcel owner and the value 'N' indicates that parcel owner is not the primary owner. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province of the project parcel owner. -
State: string
Title:
State
Maximum Length:60
The name of the state of the project parcel owner. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the project parcel owner search. Values are of the compass directions, such as N, S, E, W, NW, SE, and so on. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the project parcel owner search. -
StreetNumber: string
Title:
Street Name
Maximum Length:20
The street number in the project parcel owner search. -
StreetType: string
Title:
Street Type
Maximum Length:20
The type of street in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular unit in the building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the project parcel owner.
Nested Schema : publicSectorProjectParcels-ProjectAddress-item-post-request
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line, if available. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line, if available. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line, if available. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The first address or main address additional information of the parcel address. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The second address additional information of the parcel address, if available. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The third address additional information of the parcel address, if available. -
AddressId: integer
(int64)
Title:
Address ID
The identifier of the parcel address. -
AddressKey: integer
(int64)
Title:
Address ID
The unique identifier of the project address. -
AddressType: string
Title:
Address Type
Maximum Length:20
The type of address used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The type of building used in the address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The country code for the cell phone number of the parcel contact. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the parcel address contact. -
City: string
Title:
City
Maximum Length:60
The name of the city in the parcel address. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate value of the project parcel address. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate value of the project parcel address. -
Country: string
Title:
Country
Maximum Length:60
The name of the country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The name of the county in the parcel address. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the parcel address contact. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The country code for the fax number of the parcel contact. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the parcel address contact. -
Floor: string
Title:
Floor
Maximum Length:20
The name of the floor or level in the address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The country code for the home telephone number of the parcel address contact. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home telephone number of the parcel address contact. -
InputSource: string
Title:
Input Source
Maximum Length:1
Indicates how the data was entered or loaded into the application. The value 'S' indicates that the data entered is the system data and the value 'U' indicates the user-entered data. -
Latitude: number
Title:
Latitude
The latitude value of the parcel address. The geographic location typically identifies a specific entrance area within a large parcel area. For example, a security checkpoint gate, delivery entrance, or employee entrance. -
Longitude: number
Title:
Longitude
The longitude value of the parcel address. The geographic location typically identifies a specific entrance area within a large parcel area. For example, a security checkpoint gate, delivery entrance, or employee entrance. -
MunicipalityId: string
Title:
Municipality ID
Maximum Length:20
The municipality identifier if the parcel is not managed at the county level. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier of the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The extended postal code in the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the current project address is the primary project address. The value 'Y' indicates that the project address is the primary project address and the value 'N' indicates that address is not the primary address. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in the parcel address. -
Srid: integer
(int64)
Title:
SRID
The identifier of the parcel address. The Spatial Reference System Identifier (SRID) identifies the projected, not projected, and the local spatial coordinate system definitions. The identifier is used in all GIS systems. -
State: string
Title:
State
Maximum Length:60
The name of the state in the parcel address. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the project parcel owner search. Values are of the compass directions, such as N, S, E, W, NW, SE, and so on. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the parcel address used during a search. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel address. -
StreetType: string
Title:
Street Type
Maximum Length:20
The type of street used during the search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular unit in the building used in the address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The country code for the work telephone number of the parcel contact. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work telephone number of the parcel address contact.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorProjectParcels-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BlockNum: string
Title:
Block Number
Maximum Length:30
The block number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
BookNum: string
Title:
Book Number
Maximum Length:30
The book number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
The description of the property boundaries. The description is not a list of coordinates, it is a textual information about the boundaries. 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. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate value of the project parcel. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate value of the project parcel. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the project parcel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel was created. -
DistrictName: string
Maximum Length:
50
The name of the district 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 Code
Maximum Length:30
The land use code of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the project parcel. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel was last updated. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login ID of the user who last updated the project parcel. -
Latitude: number
Title:
Latitude
The geographic location value of the parcel that is to the north or south of the equator. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
The geographic location value of the parcel address that is to the east or west of the meridian. It typically points to a specific entrance area within a large parcel area, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
LotNum: string
Title:
Lot Number
Maximum Length:30
The lot number of the parcel in the Detail Land Information, which is a 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 name of the recorded map. For example, Public Works. -
PageNum: string
Title:
Page Number
Maximum Length:30
The page number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the project parcel. -
ParcelIdEntered: string
Title:
Parcel ID
Maximum Length:30
The Assessor Parcel Number (APN) identifier as entered by the user. -
ParcelKey: integer
(int64)
The unique identifier of the project parcel.
-
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 ID
The unique identifier of the parent parcel. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the project parcel is the primary project parcel. The value 'Y' indicates that the parcel is the primary parcel and the value 'N' indicates that parcel is not the primary parcel. The default value is 'N'. -
PrimaryZoningId: string
Title:
Primary Zoning ID
Maximum Length:30
The primary identifier of the zoning for the parcel. -
PrjParcelOwner: array
Project Parcel Owners
Title:
Project Parcel Owners
The project parcel owners resource is used to create, view, and update the project parcel owners related to a project. -
ProjectAddress: array
Project Addresses
Title:
Project Addresses
The project addresses resource is used to create, view, and update the project parcel addresses related to a project. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The description of the property. -
SectionNum: string
Title:
Section Number
Maximum Length:30
The section number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
Srid: integer
(int64)
Title:
SRID
The GIS identifier coordinate system in use. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
UnitNum: string
Title:
Unit Number
Maximum Length:30
The unit number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN). -
ZoningDescription: string
Title:
Zoning Description
Maximum Length:240
The description of the zoning.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Parcel Owners
Type:
array
Title:
Project Parcel Owners
The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.
Show Source
Nested Schema : Project Addresses
Type:
array
Title:
Project Addresses
The project addresses resource is used to create, view, and update the project parcel addresses related to a project.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorProjectParcels-PrjParcelOwner-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first or main address of the project parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the project parcel owner, if available. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of the project parcel owner, if available. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the project parcel owner, if available. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The address field of the project parcel owner search. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The address field of the project parcel owner search. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The address field of the project parcel owner search. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The type of the building. For example, Tower A or Block 3.The building type of the project parcel owner search. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The cell phone country code of the project parcel owner. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the project parcel owner. -
City: string
Title:
City
Maximum Length:60
The name of the city of the project parcel owner. -
Country: string
Title:
Country
Maximum Length:60
The name of the country of the project parcel owner. -
County: string
Title:
County
Maximum Length:60
The name of the county of the project parcel owner. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the project parcel owner. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel owner was created. -
DocumentNum: string
Title:
Document Number
Maximum Length:50
The document number of the project parcel owner. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the project parcel owner. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The fax country code of the project parcel owner. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the project parcel owner. -
Floor: string
Title:
Floor
Maximum Length:20
The floor of the building. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The home phone country code of the project parcel owner. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the project parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The last transfer date of the project parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the project parcel owner. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the project parcel owner. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel owner was last updated. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login detail of the user who last updated the project parcel owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name1: string
Title:
Name 1
Maximum Length:150
The first name of the parcel owner. -
Name2: string
Title:
Name 2
Maximum Length:150
The second name of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner ID
The unique identifier of the project parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of the parcel owner. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier of the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project parcel owner. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The postal plus four code of the project parcel owner. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the project parcel owner is the primary project parcel owner. The value 'Y' indicates that the parcel owner is the primary parcel owner and the value 'N' indicates that parcel owner is not the primary owner. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province of the project parcel owner. -
State: string
Title:
State
Maximum Length:60
The name of the state of the project parcel owner. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the project parcel owner search. Values are of the compass directions, such as N, S, E, W, NW, SE, and so on. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the project parcel owner search. -
StreetNumber: string
Title:
Street Name
Maximum Length:20
The street number in the project parcel owner search. -
StreetType: string
Title:
Street Type
Maximum Length:20
The type of street in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular unit in the building. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code of the project parcel owner. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the project parcel owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorProjectParcels-ProjectAddress-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line, if available. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line, if available. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line, if available. -
AddressField1: string
Title:
Address Field 1
Maximum Length:20
The first address or main address additional information of the parcel address. -
AddressField2: string
Title:
Address Field 2
Maximum Length:20
The second address additional information of the parcel address, if available. -
AddressField3: string
Title:
Address Field 3
Maximum Length:20
The third address additional information of the parcel address, if available. -
AddressId: integer
(int64)
Title:
Address ID
The identifier of the parcel address. -
AddressKey: integer
(int64)
Title:
Address ID
The unique identifier of the project address. -
AddressType: string
Title:
Address Type
Maximum Length:20
The type of address used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BuildingType: string
Title:
Building Type
Maximum Length:20
The type of building used in the address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country Code
Maximum Length:10
The country code for the cell phone number of the parcel contact. -
CellPhoneNum: string
Title:
Cell Phone Number
Maximum Length:40
The cell phone number of the parcel address contact. -
City: string
Title:
City
Maximum Length:60
The name of the city in the parcel address. -
CoordinateX: number
Title:
X Coordinate
The x-axis coordinate value of the project parcel address. -
CoordinateY: number
Title:
Y Coordinate
The y-axis coordinate value of the project parcel address. -
Country: string
Title:
Country
Maximum Length:60
The name of the country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The name of the county in the parcel address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the project parcel address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project parcel address was created. -
EmailId: string
Title:
Email Address
Maximum Length:50
The email address of the parcel address contact. -
FaxCountry: string
Title:
Fax Country Code
Maximum Length:10
The country code for the fax number of the parcel contact. -
FaxNum: string
Title:
Fax Number
Maximum Length:40
The fax number of the parcel address contact. -
Floor: string
Title:
Floor
Maximum Length:20
The name of the floor or level in the address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country Code
Maximum Length:10
The country code for the home telephone number of the parcel address contact. -
HomePhoneNum: string
Title:
Home Phone Number
Maximum Length:40
The home telephone number of the parcel address contact. -
InputSource: string
Title:
Input Source
Maximum Length:1
Indicates how the data was entered or loaded into the application. The value 'S' indicates that the data entered is the system data and the value 'U' indicates the user-entered data. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the project parcel address. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project parcel address was last updated. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login detail of the user who last updated the project parcel address. -
Latitude: number
Title:
Latitude
The latitude value of the parcel address. The geographic location typically identifies a specific entrance area within a large parcel area. For example, a security checkpoint gate, delivery entrance, or employee entrance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
The longitude value of the parcel address. The geographic location typically identifies a specific entrance area within a large parcel area. For example, a security checkpoint gate, delivery entrance, or employee entrance. -
MunicipalityId: string
Title:
Municipality ID
Maximum Length:20
The municipality identifier if the parcel is not managed at the county level. -
ParcelId: integer
(int64)
Title:
Parcel ID
The identifier of the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel ID
The unique identifier of the project parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The extended postal code in the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the current project address is the primary project address. The value 'Y' indicates that the project address is the primary project address and the value 'N' indicates that address is not the primary address. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in the parcel address. -
Srid: integer
(int64)
Title:
SRID
The identifier of the parcel address. The Spatial Reference System Identifier (SRID) identifies the projected, not projected, and the local spatial coordinate system definitions. The identifier is used in all GIS systems. -
State: string
Title:
State
Maximum Length:60
The name of the state in the parcel address. -
StreetDirection: string
Title:
Street Direction
Maximum Length:10
The street direction in the project parcel owner search. Values are of the compass directions, such as N, S, E, W, NW, SE, and so on. -
StreetName: string
Title:
Street Name
Maximum Length:240
The name of the street in the parcel address used during a search. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel address. -
StreetType: string
Title:
Street Type
Maximum Length:20
The type of street used during the search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit Number
Maximum Length:30
The particular unit in the building used in the address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country Code
Maximum Length:10
The country code for the work telephone number of the parcel contact. -
WorkPhoneNum: string
Title:
Work Phone Number
Maximum Length:40
The work telephone number of the parcel address contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PrjParcelOwner
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwnerParameters:
- ParcelKey:
$request.path.ParcelKey
The project parcel owners resource is used to create, view, and update the project parcel owners related to a project. - ParcelKey:
- ProjectAddress
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddressParameters:
- ParcelKey:
$request.path.ParcelKey
The project addresses resource is used to create, view, and update the project parcel addresses related to a project. - ParcelKey: