Jump to

• Request
• Response

Update a project parcel

patch

/fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}

Request

Path Parameters

• ParcelKey(required): integer(int64)
  The unique identifier of the project parcel.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":true,
            "default":false
        },
        "PrjParcelOwner":{
            "title":"Project Parcel Owners",
            "type":"array",
            "description":"The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectParcels-PrjParcelOwner-item-patch-request"
            }
        },
        "PageNum":{
            "title":"Page Number",
            "maxLength":"30",
            "type":"string",
            "description":"The page number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The geographic location value of the parcel that is to the north or south of the equator.",
            "nullable":true
        },
        "ParentParcelId":{
            "title":"Parent Parcel ID",
            "type":"integer",
            "description":"The unique identifier of the parent parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProjectAddress":{
            "title":"Project Addresses",
            "type":"array",
            "description":"The project addresses resource is used to create, view, and update the project parcel addresses related to a project.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectParcels-ProjectAddress-item-patch-request"
            }
        },
        "LotNum":{
            "title":"Lot Number",
            "maxLength":"30",
            "type":"string",
            "description":"The lot number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "MapBookPage":{
            "title":"Map Book Page",
            "maxLength":"50",
            "type":"string",
            "description":"The recorded map book and page.",
            "nullable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel ID",
            "maxLength":"30",
            "type":"string",
            "description":"The Assessor Parcel Number (APN) identifier as entered by the user.",
            "nullable":false
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the parcel. For example, commercial, residential, or government.",
            "nullable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BlockNum":{
            "title":"Block Number",
            "maxLength":"30",
            "type":"string",
            "description":"The block number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "UnitNum":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unit number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "Subdivision":{
            "title":"Subdivision",
            "maxLength":"30",
            "type":"string",
            "description":"The subdivision of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "BookNum":{
            "title":"Book Number",
            "maxLength":"30",
            "type":"string",
            "description":"The book number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "ZoningDescription":{
            "title":"Zoning Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the zoning.",
            "nullable":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
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the property.",
            "nullable":true
        },
        "DistrictName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the district of the parcel.",
            "nullable":true
        },
        "MapName":{
            "title":"Map Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the recorded map. For example, Public Works.",
            "nullable":true
        },
        "SectionNum":{
            "title":"Section Number",
            "maxLength":"30",
            "type":"string",
            "description":"The section number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate value of the project parcel.",
            "nullable":true
        },
        "LandUseCode":{
            "title":"Land Use Code",
            "maxLength":"30",
            "type":"string",
            "description":"The land use code of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"The GIS identifier coordinate system in use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate value of the project parcel.",
            "nullable":true
        },
        "PrimaryZoningId":{
            "title":"Primary Zoning ID",
            "maxLength":"30",
            "type":"string",
            "description":"The primary identifier of the zoning for the parcel.",
            "nullable":true
        },
        "BoundaryDescription":{
            "title":"Boundary Description",
            "maxLength":"480",
            "type":"string",
            "description":"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.",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Project Parcel Owners",
    "type":"array",
    "description":"The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectParcels-PrjParcelOwner-item-patch-request"
    }
}

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

• Array of: object publicSectorProjectParcels-ProjectAddress-item-patch-request

{
    "title":"Project Addresses",
    "type":"array",
    "description":"The project addresses resource is used to create, view, and update the project parcel addresses related to a project.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectParcels-ProjectAddress-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• 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'.
• 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.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the street in the project parcel owner search.",
            "nullable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The cell phone country code of the project parcel owner.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":true,
            "default":false
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The fax country code of the project parcel owner.",
            "nullable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the project parcel owner.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the project parcel owner.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county of the project parcel owner.",
            "nullable":true
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of the parcel owner.",
            "nullable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of the building. For example, Tower A or Block 3.The building type of the project parcel owner search.",
            "nullable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identifier of the parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line of the project parcel owner, if available.",
            "nullable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The work phone country code of the project parcel owner.",
            "nullable":true
        },
        "DocumentNum":{
            "title":"Document Number",
            "maxLength":"50",
            "type":"string",
            "description":"The document number of the project parcel owner.",
            "nullable":true
        },
        "StreetNumber":{
            "title":"Street Name",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the project parcel owner search.",
            "nullable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true
        },
        "Name1":{
            "title":"Name 1",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the parcel owner.",
            "nullable":true
        },
        "Name2":{
            "title":"Name 2",
            "maxLength":"150",
            "type":"string",
            "description":"The second name of the parcel owner.",
            "nullable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The floor of the building. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":"50",
            "type":"string",
            "description":"The email address of the project parcel owner.",
            "nullable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":"50",
            "type":"string",
            "description":"The last transfer type of the project parcel owner.",
            "nullable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The home phone number of the project parcel owner.",
            "nullable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the project parcel owner, if available.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line of the project parcel owner, if available.",
            "nullable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address of the project parcel owner.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city of the project parcel owner.",
            "nullable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of street in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of the project parcel owner.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province of the project parcel owner.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"The postal plus four code of the project parcel owner.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state of the project parcel owner.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the country of the project parcel owner.",
            "nullable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the project parcel owner.",
            "nullable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The particular unit in the building. For example, Apartment 208A or Suite 300.",
            "nullable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The home phone country code of the project parcel owner.",
            "nullable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "description":"The last transfer date of the project parcel owner.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : publicSectorProjectParcels-ProjectAddress-item-patch-request

Type: object

Show Source

• 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.
• 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.
• 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.
• 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'.
• 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.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the street in the parcel address used during a search.",
            "nullable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the cell phone number of the parcel contact.",
            "nullable":true
        },
        "InputSource":{
            "title":"Input Source",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":true,
            "default":false
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the fax number of the parcel contact.",
            "nullable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the parcel address contact.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county in the parcel address.",
            "nullable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of building used in the address search. For example, Tower A or Block 3.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line, if available.",
            "nullable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the work telephone number of the parcel contact.",
            "nullable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":"20",
            "type":"string",
            "description":"The first address or main address additional information of the parcel address.",
            "nullable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":"20",
            "type":"string",
            "description":"The third address additional information of the parcel address, if available.",
            "nullable":true
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":"20",
            "type":"string",
            "description":"The second address additional information of the parcel address, if available.",
            "nullable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The name of the floor or level in the address search. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":"50",
            "type":"string",
            "description":"The email address of the parcel address contact.",
            "nullable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The home telephone number of the parcel address contact.",
            "nullable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line, if available.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line, if available.",
            "nullable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city in the parcel address.",
            "nullable":true
        },
        "MunicipalityId":{
            "title":"Municipality ID",
            "maxLength":"20",
            "type":"string",
            "description":"The municipality identifier if the parcel is not managed at the county level.",
            "nullable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of street used during the search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work telephone number of the parcel address contact.",
            "nullable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province in the parcel address.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"The extended postal code in the parcel address.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state in the parcel address.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the country in the parcel address.",
            "nullable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the parcel address contact.",
            "nullable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The particular unit in the building used in the address search. For example, Apartment 208A or Suite 300.",
            "nullable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the home telephone number of the parcel address contact.",
            "nullable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of address used for delivery point validation (DPV). For example, main address, side address, or virtual address.",
            "nullable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate value of the project parcel address.",
            "nullable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate value of the project parcel address.",
            "nullable":true
        }
    }
}

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 : publicSectorProjectParcels-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PrjParcelOwner":{
            "title":"Project Parcel Owners",
            "type":"array",
            "description":"The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectParcels-PrjParcelOwner-item-response"
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PageNum":{
            "title":"Page Number",
            "maxLength":"30",
            "type":"string",
            "description":"The page number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The geographic location value of the parcel that is to the north or south of the equator.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentParcelId":{
            "title":"Parent Parcel ID",
            "type":"integer",
            "description":"The unique identifier of the parent parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectAddress":{
            "title":"Project Addresses",
            "type":"array",
            "description":"The project addresses resource is used to create, view, and update the project parcel addresses related to a project.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectParcels-ProjectAddress-item-response"
            }
        },
        "LotNum":{
            "title":"Lot Number",
            "maxLength":"30",
            "type":"string",
            "description":"The lot number of the parcel in the Detail Land Information, which is a 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
        },
        "ParcelIdEntered":{
            "title":"Parcel ID",
            "maxLength":"30",
            "type":"string",
            "description":"The Assessor Parcel Number (APN) identifier 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":{
            "type":"integer",
            "description":"The unique identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the project parcel was last updated.",
            "nullable":false,
            "readOnly":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
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the project parcel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BlockNum":{
            "title":"Block Number",
            "maxLength":"30",
            "type":"string",
            "description":"The block number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNum":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unit number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Subdivision":{
            "title":"Subdivision",
            "maxLength":"30",
            "type":"string",
            "description":"The subdivision of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BookNum":{
            "title":"Book Number",
            "maxLength":"30",
            "type":"string",
            "description":"The book number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "ZoningDescription":{
            "title":"Zoning Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the zoning.",
            "nullable":true,
            "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 description of the property.",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the district of the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "MapName":{
            "title":"Map Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the recorded map. For example, Public Works.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionNum":{
            "title":"Section Number",
            "maxLength":"30",
            "type":"string",
            "description":"The section number of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate value of the project parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "LandUseCode":{
            "title":"Land Use Code",
            "maxLength":"30",
            "type":"string",
            "description":"The land use code of the parcel in the Detail Land Information, which is a part of the Assessor Parcel Number (APN).",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"The GIS identifier coordinate system in use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate value of the project parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryZoningId":{
            "title":"Primary Zoning ID",
            "maxLength":"30",
            "type":"string",
            "description":"The primary identifier of the zoning for the parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "BoundaryDescription":{
            "title":"Boundary Description",
            "maxLength":"480",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the project parcel.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login ID of the user who last updated the project parcel.",
            "nullable":true,
            "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 : 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

• Array of: object publicSectorProjectParcels-PrjParcelOwner-item-response

{
    "title":"Project Parcel Owners",
    "type":"array",
    "description":"The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectParcels-PrjParcelOwner-item-response"
    }
}

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

• Array of: object publicSectorProjectParcels-ProjectAddress-item-response

{
    "title":"Project Addresses",
    "type":"array",
    "description":"The project addresses resource is used to create, view, and update the project parcel addresses related to a project.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectParcels-ProjectAddress-item-response"
    }
}

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

Nested Schema : publicSectorProjectParcels-PrjParcelOwner-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the street in the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel owner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The cell phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The fax country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerType":{
            "title":"Owner Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of the building. For example, Tower A or Block 3.The building type of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The work phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Name",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the project parcel owner search.",
            "nullable":true,
            "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 ID",
            "type":"integer",
            "description":"The unique identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name1":{
            "title":"Name 1",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Name2":{
            "title":"Name 2",
            "maxLength":"150",
            "type":"string",
            "description":"The second name of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the project parcel owner was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":"50",
            "type":"string",
            "description":"The email address of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the project parcel owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The home phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of street in the project parcel owner search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"The postal plus four code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the project parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the country of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The particular unit in the building. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login detail of the user who last updated the project parcel owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identifier of the parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line of the project parcel owner, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNum":{
            "title":"Document Number",
            "maxLength":"50",
            "type":"string",
            "description":"The document number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":"20",
            "type":"string",
            "description":"The address field of the project parcel owner search.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The floor of the building. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":"50",
            "type":"string",
            "description":"The last transfer type of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the project parcel owner, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line of the project parcel owner, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The home phone country code of the project parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "description":"The last transfer date of the project parcel owner.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the project parcel owner.",
            "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 : publicSectorProjectParcels-ProjectAddress-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the street in the parcel address used during a search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the cell phone number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "InputSource":{
            "title":"Input Source",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the fax number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of building used in the address search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the work telephone number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":true,
            "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 ID",
            "type":"integer",
            "description":"The unique identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the project parcel address was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":"50",
            "type":"string",
            "description":"The email address of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the project parcel address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressKey":{
            "title":"Address ID",
            "type":"integer",
            "description":"The unique identifier of the project address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of street used during the search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"The extended postal code in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the country in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"The particular unit in the building used in the address search. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate value of the project parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate value of the project parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login detail of the user who last updated the project parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":"20",
            "type":"string",
            "description":"The first address or main address additional information of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":"20",
            "type":"string",
            "description":"The third address additional information of the parcel address, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":"20",
            "type":"string",
            "description":"The second address additional information of the parcel address, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The name of the floor or level in the address search. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "x-queryable":true
        },
        "MunicipalityId":{
            "title":"Municipality ID",
            "maxLength":"20",
            "type":"string",
            "description":"The municipality identifier if the parcel is not managed at the county level.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of address used for delivery point validation (DPV). For example, main address, side address, or virtual address.",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the project parcel address.",
            "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"
    }
}

Links

PrjParcelOwner

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/PrjParcelOwner

Parameters:

• ParcelKey: $request.path.ParcelKey

The project parcel owners resource is used to create, view, and update the project parcel owners related to a project.

ProjectAddress

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorProjectParcels/{ParcelKey}/child/ProjectAddress

Parameters:

• ParcelKey: $request.path.ParcelKey

The project addresses resource is used to create, view, and update the project parcel addresses related to a project.

Back to Top